OOFlasherEntity Class Reference

#include <OOFlasherEntity.h>

Inheritance diagram for OOFlasherEntity:

Collaboration diagram for OOFlasherEntity:

Instance Methods
(id)	- initWithDictionary:
(BOOL)	- isActive
(void)	- setActive:
(OOColor *)	- color
(float)	- frequency
(void)	- setFrequency:
(float)	- phase
(void)	- setPhase:
(float)	- fraction
(void)	- setFraction:
(void)	- dealloc [implementation]
(void)	- setUpColors: [implementation]
(void)	- getCurrentColorComponents [implementation]
(void)	- update: [implementation]
(void)	- drawImmediate:translucent: [implementation]
(void)	- drawSubEntityImmediate:translucent: [implementation]
(BOOL)	- isFlasher [implementation]
(double)	- findCollisionRadius [implementation]
(void)	- rescaleBy: [implementation]
(void)	- rescaleBy:writeToCache: [implementation]
(void)	- getJSClass:andPrototype:
(NSString *)	- oo_jsClassName
(BOOL)	- isVisibleToScripts
Instance Methods inherited from OOLightParticleEntity
(id)	- initWithDiameter:
(float)	- diameter
(void)	- setDiameter:
(void)	- setColor:
(void)	- setColor:alpha:
(OOTexture *)	- texture
(BOOL)	- isEffect [implementation]
(BOOL)	- canCollide [implementation]
(NSSet *)	- allTextures [implementation]
Instance Methods inherited from Entity
(NSUInteger)	- sessionID
(BOOL)	- isShip
(BOOL)	- isDock
(BOOL)	- isStation
(BOOL)	- isSubEntity
(BOOL)	- isPlayer
(BOOL)	- isPlanet
(BOOL)	- isSun
(BOOL)	- isSunlit
(BOOL)	- isStellarObject
(BOOL)	- isSky
(BOOL)	- isWormhole
(BOOL)	- isVisualEffect
(BOOL)	- isWaypoint
(BOOL)	- validForAddToUniverse
(void)	- addToLinkedLists
(void)	- removeFromLinkedLists
(void)	- updateLinkedLists
(void)	- wasAddedToUniverse
(void)	- wasRemovedFromUniverse
(void)	- warnAboutHostiles
(CollisionRegion *)	- collisionRegion
(void)	- setCollisionRegion:
(void)	- setUniversalID:
(OOUniversalID)	- universalID
(BOOL)	- throwingSparks
(void)	- setThrowSparks:
(void)	- throwSparks
(void)	- setOwner:
(id)	- owner
(ShipEntity *)	- parentEntity
(ShipEntity *)	- rootShipEntity
(void)	- setPosition:
(void)	- setPositionX:y:z:
(HPVector)	- position
(Vector)	- cameraRelativePosition
(GLfloat)	- cameraRangeFront
(GLfloat)	- cameraRangeBack
(void)	- updateCameraRelativePosition
(Vector)	- vectorTo:
(HPVector)	- absolutePositionForSubentity
(HPVector)	- absolutePositionForSubentityOffset:
(double)	- zeroDistance
(double)	- camZeroDistance
(NSComparisonResult)	- compareZeroDistance:
(BoundingBox)	- boundingBox
(GLfloat)	- mass
(Quaternion)	- orientation
(void)	- setOrientation:
(Quaternion)	- normalOrientation
(void)	- setNormalOrientation:
(void)	- orientationChanged
(void)	- setVelocity:
(Vector)	- velocity
(double)	- speed
(GLfloat)	- distanceTravelled
(void)	- setDistanceTravelled:
(void)	- setStatus:
(OOEntityStatus)	- status
(void)	- setScanClass:
(OOScanClass)	- scanClass
(void)	- setEnergy:
(GLfloat)	- energy
(void)	- setMaxEnergy:
(GLfloat)	- maxEnergy
(void)	- applyRoll:andClimb:
(void)	- applyRoll:climb:andYaw:
(void)	- moveForward:
(OOMatrix)	- rotationMatrix
(OOMatrix)	- drawRotationMatrix
(OOMatrix)	- transformationMatrix
(OOMatrix)	- drawTransformationMatrix
(GLfloat)	- collisionRadius
(GLfloat)	- frustumRadius
(void)	- setCollisionRadius:
(NSMutableArray *)	- collisionArray
(void)	- applyVelocity:
(BOOL)	- checkCloseCollisionWith:
(void)	- takeEnergyDamage:from:becauseOf:weaponIdentifier:
(void)	- dumpState
(void)	- dumpSelfState
(BOOL)	- isVisible
(BOOL)	- isInSpace
(BOOL)	- isImmuneToBreakPatternHide
(GLfloat)	- universalTime
(GLfloat)	- spawnTime
(GLfloat)	- timeElapsedSinceSpawn
(void)	- setAtmosphereFogging:
(OOColor *)	- fogUniform
(NSString *)	- descriptionForObjDumpBasic
(NSString *)	- descriptionForObjDump
(id)	- init [implementation]
(NSString *)	- descriptionComponents [implementation]
(BOOL)	- checkLinkedLists [implementation]
(id< OOWeakReferenceSupport >)	- superShaderBindingTarget [implementation]
(Vector)	- relativePosition [implementation]
(void)	- subEntityReallyDied: [implementation]
(BOOL)	- isBreakPattern
(void)	- inspect [implementation]
(BOOL)	- isECMBlast
(NSArray *)	- debugInspectorModules [implementation]
(NSString *)	- inspScanClassLine
(NSString *)	- inspStatusLine
(NSString *)	- inspRetainCountLine
(NSString *)	- inspPositionLine
(NSString *)	- inspVelocityLine
(NSString *)	- inspOrientationLine
(NSString *)	- inspEnergyLine
(NSString *)	- inspOwnerLine
(NSString *)	- inspTargetLine
(NSString *)	- inspDescription [implementation]
(NSString *)	- inspBasicIdentityLine [implementation]
(BOOL)	- isExhaust
(void)	- deleteJSSelf
(jsval)	- oo_jsValueInContext: [implementation]
(BOOL)	- isCascadeWeapon
(BOOL)	- isPlayerLikeShip
(GLfloat)	- clock [implementation]
(unsigned)	- pseudoFixedD100 [implementation]
(unsigned)	- pseudoFixedD256 [implementation]
(unsigned)	- systemGovernment [implementation]
(unsigned)	- systemEconomy [implementation]
(unsigned)	- systemTechLevel [implementation]
(unsigned)	- systemPopulation [implementation]
(unsigned)	- systemProductivity [implementation]
(BOOL)	- isShipWithSubEntityShip:
Instance Methods inherited from OOWeakRefObject
(id)	- weakSelf
(id)	- weakRetain [implementation]
(void)	- weakRefDied: [implementation]
Instance Methods inherited from <OOWeakReferenceSupport>
(id)	- OO_RETURNS_RETAINED

Class Methods
(instancetype)	+ flasherWithDictionary:
Class Methods inherited from OOLightParticleEntity
(void)	+ setUpTexture
(OOTexture *)	+ defaultParticleTexture
(void)	+ resetGraphicsState [implementation]

Private Attributes
float	_frequency
float	_phase
float	_wave
float	_brightfraction
NSArray *	_colors
NSUInteger	_activeColor
OOTimeDelta	_time
BOOL	_active
BOOL	_justSwitched

Additional Inherited Members
Public Attributes inherited from Entity
OOUniversalID	universalID
unsigned	isShip: 1
unsigned	isStation: 1
unsigned	isPlayer: 1
unsigned	isWormhole: 1
unsigned	isSubEntity: 1
unsigned	hasMoved: 1
unsigned	hasRotated: 1
unsigned	hasCollided: 1
unsigned	isSunlit: 1
unsigned	collisionTestFilter: 2
unsigned	throw_sparks: 1
unsigned	isImmuneToBreakPatternHide: 1
unsigned	isExplicitlyNotMainStation: 1
unsigned	isVisualEffect: 1
OOScanClass	scanClass
GLfloat	zero_distance
GLfloat	cam_zero_distance
GLfloat	no_draw_distance
GLfloat	collision_radius
HPVector	position
Vector	cameraRelativePosition
Quaternion	orientation
OOColor *	atmosphereFogging
int	zero_index
Entity *	x_previous
Entity *	x_next
Entity *	y_previous
Entity *	y_next
Entity *	z_previous
Entity *	z_next
Entity *	collision_chain
OOUniversalID	shadingEntityID
Entity *	collider
CollisionRegion *	collisionRegion
Protected Attributes inherited from OOLightParticleEntity
GLfloat	_colorComponents [4]
float	_diameter
Protected Attributes inherited from Entity
HPVector	lastPosition
Quaternion	lastOrientation
GLfloat	distanceTravelled
OOMatrix	rotMatrix
Vector	velocity
GLfloat	energy
GLfloat	maxEnergy
BoundingBox	boundingBox
GLfloat	mass
NSMutableArray *	collidingEntities
OOTimeAbsolute	spawnTime
struct JSObject *	_jsSelf
Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 32 of file OOFlasherEntity.h.

Method Documentation

color

- (OOColor *) color

Definition at line 109 of file OOFlasherEntity.m.

{
    return [OOColor colorWithRed:_colorComponents[0]
                           green:_colorComponents[1]
                            blue:_colorComponents[2]
                           alpha:_colorComponents[3]];
}

References color, and OOColor::colorWithRed:green:blue:alpha:.

Referenced by color, and FlasherGetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Reimplemented from Entity.

Definition at line 69 of file OOFlasherEntity.m.

{
    [_colors release];
    
    [super dealloc];
}

References Entity::dealloc, and dealloc.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

drawImmediate:translucent:

- (void) drawImmediate: (bool) immediate translucent: (bool) translucent

implementation

Reimplemented from OOLightParticleEntity.

Definition at line 202 of file OOFlasherEntity.m.

                      :(bool)immediate translucent:(bool)translucent
{
    if (_active)
    {
        [super drawImmediate:immediate translucent:translucent];
    }
}

References _active, and OOLightParticleEntity::drawImmediate:translucent:.

Here is the call graph for this function:

drawSubEntityImmediate:translucent:

- (void) drawSubEntityImmediate: (bool) immediate translucent: (bool) translucent

implementation

Reimplemented from OOLightParticleEntity.

Definition at line 211 of file OOFlasherEntity.m.

                               :(bool)immediate translucent:(bool)translucent
{
    if (_active)
    {
        [super drawSubEntityImmediate:immediate translucent:translucent];
    }
}

References _active, and OOLightParticleEntity::drawSubEntityImmediate:translucent:.

Here is the call graph for this function:

findCollisionRadius

- (double) findCollisionRadius

implementation

Reimplemented from Entity.

Definition at line 226 of file OOFlasherEntity.m.

{
    return [self diameter] / 2.0;
}

References OOLightParticleEntity::diameter, and findCollisionRadius.

Referenced by findCollisionRadius.

Here is the call graph for this function:

Here is the caller graph for this function:

flasherWithDictionary:

+ (instancetype) flasherWithDictionary:

(NSDictionary *)

dictionary

Definition at line 44 of file OOFlasherEntity.m.

                                      :(NSDictionary *)dictionary
{
    return [[[OOFlasherEntity alloc] initWithDictionary:dictionary] autorelease];
}

Referenced by OOVisualEffectEntity(Private)::setUpOneFlasher:, and ShipEntity(Private)::setUpOneFlasher:.

Here is the caller graph for this function:

fraction

- (float) fraction

Definition at line 142 of file OOFlasherEntity.m.

{
    return _brightfraction;
}

References _brightfraction, and fraction.

Referenced by fraction, and setFraction:.

Here is the call graph for this function:

Here is the caller graph for this function:

frequency

- (float) frequency

Definition at line 118 of file OOFlasherEntity.m.

{
    return _frequency;
}

References _frequency, and frequency.

Referenced by frequency, and setFrequency:.

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentColorComponents

- (void) getCurrentColorComponents

implementation

Provided by category OOFlasherEntity(Internal).

Definition at line 91 of file OOFlasherEntity.m.

{
    [self setColor:[_colors objectAtIndex:_activeColor] alpha:_colorComponents[3]];
}

References OOFlasherEntity(Internal)::getCurrentColorComponents, and OOLightParticleEntity::setColor:alpha:.

Referenced by OOFlasherEntity(Internal)::getCurrentColorComponents, and initWithDictionary:.

Here is the call graph for this function:

Here is the caller graph for this function:

getJSClass:andPrototype:

- (void) getJSClass:		(JSClass **)	outClass
andPrototype:		(JSObject **)	outPrototype

Reimplemented from Entity.

Provided by category OOFlasherEntity(OOJavaScriptExtensions).

Definition at line 128 of file OOJSFlasher.m.

                  :(JSClass **)outClass andPrototype:(JSObject **)outPrototype
{
    *outClass = &sFlasherClass;
    *outPrototype = sFlasherPrototype;
}

initWithDictionary:

- (id) initWithDictionary:

(NSDictionary *)

dictionary

Definition at line 50 of file OOFlasherEntity.m.

                         :(NSDictionary *)dictionary
{
    float size = [dictionary oo_floatForKey:@"size" defaultValue:1.0f];
    
    if ((self = [super initWithDiameter:size]))
    {
        _frequency = [dictionary oo_floatForKey:@"frequency" defaultValue:1.0f] * 2.0f;
        _phase = [dictionary oo_floatForKey:@"phase" defaultValue:0.0f];
        _brightfraction = [dictionary oo_floatForKey:@"bright_fraction" defaultValue:0.5f];
 
        [self setUpColors:[dictionary oo_arrayForKey:@"colors"]];
        [self getCurrentColorComponents];
        
        [self setActive:[dictionary oo_boolForKey:@"initially_on" defaultValue:YES]];
    }
    return self;
}

References _brightfraction, _frequency, _phase, getCurrentColorComponents, setActive:, and setUpColors:.

Here is the call graph for this function:

isActive

- (BOOL) isActive

Definition at line 97 of file OOFlasherEntity.m.

{
    return _active;
}

References _active, and isActive.

Referenced by isActive.

Here is the call graph for this function:

Here is the caller graph for this function:

isFlasher

- (BOOL) isFlasher

implementation

Reimplemented from Entity.

Definition at line 220 of file OOFlasherEntity.m.

{
    return YES;
}

References isFlasher.

Referenced by isFlasher.

Here is the call graph for this function:

Here is the caller graph for this function:

isVisibleToScripts

- (BOOL) isVisibleToScripts

Reimplemented from Entity.

Provided by category OOFlasherEntity(OOJavaScriptExtensions).

Definition at line 140 of file OOJSFlasher.m.

{
    return YES;
}

oo_jsClassName

- (NSString *) oo_jsClassName

Reimplemented from Entity.

Provided by category OOFlasherEntity(OOJavaScriptExtensions).

Definition at line 135 of file OOJSFlasher.m.

{
    return @"Flasher";
}

phase

- (float) phase

Definition at line 130 of file OOFlasherEntity.m.

{
    return _phase;
}

References _phase, and phase.

Referenced by phase, and setPhase:.

Here is the call graph for this function:

Here is the caller graph for this function:

rescaleBy:

- (void) rescaleBy: (GLfloat) factor

implementation

Reimplemented from <OOSubEntity>.

Definition at line 232 of file OOFlasherEntity.m.

                  :(GLfloat)factor
{
    [self setDiameter:[self diameter] * factor];
}

References OOLightParticleEntity::diameter, and OOLightParticleEntity::setDiameter:.

Referenced by ShipEntity(Private)::setUpOneFlasher:.

Here is the call graph for this function:

Here is the caller graph for this function:

rescaleBy:writeToCache:

- (void) rescaleBy: (GLfloat) factor writeToCache: (BOOL) writeToCache

implementation

Reimplemented from <OOSubEntity>.

Definition at line 238 of file OOFlasherEntity.m.

                  :(GLfloat)factor writeToCache:(BOOL)writeToCache
{
    /* Do nothing; this is only needed because of OOEntityWithDrawable
       implementation requirements */
}

setActive:

- (void) setActive:

(BOOL)

active

Definition at line 103 of file OOFlasherEntity.m.

                  :(BOOL)active
{
    _active = !!active;
}

References _active.

Referenced by FlasherSetProperty(), and initWithDictionary:.

Here is the caller graph for this function:

setFraction:

- (void) setFraction:

(float)

fraction

Definition at line 148 of file OOFlasherEntity.m.

                    :(float)fraction
{
    _brightfraction = fraction;
}

References _brightfraction, and fraction.

Referenced by FlasherSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

setFrequency:

- (void) setFrequency:

(float)

frequency

Definition at line 124 of file OOFlasherEntity.m.

                     :(float)frequency
{
    _frequency = frequency;
}

References _frequency, and frequency.

Referenced by FlasherSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

setPhase:

- (void) setPhase:

(float)

phase

Definition at line 136 of file OOFlasherEntity.m.

                 :(float)phase
{
    _phase = phase;
}

References _phase, and phase.

Referenced by FlasherSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

setUpColors:

- (void) setUpColors: (NSArray *) colorSpecifiers

implementation

Provided by category OOFlasherEntity(Internal).

Definition at line 77 of file OOFlasherEntity.m.

                    :(NSArray *)colorSpecifiers
{
    NSMutableArray *colors = [NSMutableArray arrayWithCapacity:[colorSpecifiers count]];
    id specifier = nil;
    NSEnumerator *specEnum = [colorSpecifiers objectEnumerator];
    while ((specifier = [specEnum nextObject]))
    {
        [colors addObject:[OOColor colorWithDescription:specifier saturationFactor:0.75f]];
    }
    
    _colors = [colors copy];
}

References OOColor::colorWithDescription:saturationFactor:, and nil.

Referenced by initWithDictionary:.

Here is the call graph for this function:

Here is the caller graph for this function:

update:

- (void) update: (OOTimeDelta) delta_t

implementation

Reimplemented from Entity.

Definition at line 154 of file OOFlasherEntity.m.

               :(OOTimeDelta) delta_t
{
    [super update:delta_t];
    
    _time += delta_t;
 
    if (_frequency != 0)
    {
        float wave = sinf(_frequency * M_PI * (_time + _phase));
        NSUInteger count = [_colors count];
        if (count > 1 && wave < 0) 
        {
            if (!_justSwitched && wave > _wave)   // don't test for wave >= _wave - could give wrong results with very low frequencies
            {
                _justSwitched = YES;
                ++_activeColor;
                _activeColor %= count; //_activeColor = ++_activeColor % count; is potentially undefined operation
                [self setColor:[_colors objectAtIndex:_activeColor]];
            }
        }
        else if (_justSwitched)
        {
            _justSwitched = NO;
        }
 
        float threshold = cosf(_brightfraction * M_PI);
        
        float brightness = _brightfraction;
        if (wave > threshold)
        {
            brightness = _brightfraction + (((1-_brightfraction)/(1-threshold))*(wave-threshold));
        }
        else if (wave < threshold)
        {
            brightness = _brightfraction + ((_brightfraction/(threshold+1))*(wave-threshold));
        }
 
        _colorComponents[3] = brightness;
        
        _wave = wave;
    }
    else
    {
        _colorComponents[3] = 1.0;
    }
}

References _activeColor, _brightfraction, OOLightParticleEntity::_colorComponents, _frequency, _justSwitched, _phase, _time, _wave, count, M_PI, OOLightParticleEntity::setColor:, and Entity::update:.

Here is the call graph for this function:

Member Data Documentation

_active

- (BOOL) _active

private

Definition at line 45 of file OOFlasherEntity.h.

Referenced by drawImmediate:translucent:, drawSubEntityImmediate:translucent:, isActive, and setActive:.

_activeColor

- (NSUInteger) _activeColor

private

Definition at line 41 of file OOFlasherEntity.h.

Referenced by update:.

_brightfraction

- (float) _brightfraction

private

Definition at line 39 of file OOFlasherEntity.h.

Referenced by fraction, initWithDictionary:, setFraction:, and update:.

_colors

- (NSArray*) _colors

private

Definition at line 40 of file OOFlasherEntity.h.

_frequency

- (float) _frequency

private

Definition at line 36 of file OOFlasherEntity.h.

Referenced by frequency, initWithDictionary:, setFrequency:, and update:.

_justSwitched

- (BOOL) _justSwitched

private

Definition at line 46 of file OOFlasherEntity.h.

Referenced by update:.

_phase

- (float) _phase

private

Definition at line 37 of file OOFlasherEntity.h.

Referenced by initWithDictionary:, phase, setPhase:, and update:.

_time

- (OOTimeDelta) _time

private

Definition at line 43 of file OOFlasherEntity.h.

Referenced by update:.

_wave

- (float) _wave

private

Definition at line 38 of file OOFlasherEntity.h.

Referenced by update:.

---

The documentation for this class was generated from the following files:

• src/Core/Entities/OOFlasherEntity.h
• src/Core/Entities/OOFlasherEntity.m