OOSparkEntity Class Reference

#include <OOSparkEntity.h>

Inheritance diagram for OOSparkEntity:

Collaboration diagram for OOSparkEntity:

Instance Methods
(id)	- initWithPosition:velocity:duration:size:color:
(void)	- update: [implementation]
(void)	- performUpdate: [implementation]
Instance Methods inherited from OOLightParticleEntity
(id)	- initWithDiameter:
(float)	- diameter
(void)	- setDiameter:
(void)	- setColor:
(void)	- setColor:alpha:
(OOTexture *)	- texture
(void)	- drawSubEntityImmediate:translucent:
(void)	- drawImmediate:translucent: [implementation]
(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
(double)	- findCollisionRadius
(BOOL)	- isVisible
(BOOL)	- isInSpace
(BOOL)	- isImmuneToBreakPatternHide
(GLfloat)	- universalTime
(GLfloat)	- spawnTime
(GLfloat)	- timeElapsedSinceSpawn
(void)	- setAtmosphereFogging:
(OOColor *)	- fogUniform
(NSString *)	- descriptionForObjDumpBasic
(NSString *)	- descriptionForObjDump
(id)	- init [implementation]
(void)	- dealloc [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
(BOOL)	- isFlasher
(BOOL)	- isVisibleToScripts
(NSString *)	- oo_jsClassName
(void)	- getJSClass:andPrototype:
(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

Private Attributes
GLfloat	_baseRGBA [4]
GLfloat	_duration
GLfloat	_timeRemaining

Additional Inherited Members
Class Methods inherited from OOLightParticleEntity
(void)	+ setUpTexture
(OOTexture *)	+ defaultParticleTexture
(void)	+ resetGraphicsState [implementation]
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 29 of file OOSparkEntity.h.

Method Documentation

initWithPosition:velocity:duration:size:color:

- (id) initWithPosition:		(HPVector)	position
velocity:		(Vector)	velocity
duration:		(OOTimeDelta)	duration
size:		(float)	size
color:		(OOColor *)	color

Definition at line 41 of file OOSparkEntity.m.

                       :(HPVector)pos
               velocity:(Vector)vel
               duration:(OOTimeDelta)duration
                   size:(float)size
                  color:(OOColor *)color
{
    if ((self = [super initWithDiameter:size]))
    {
        [self setPosition:pos];
        [self setVelocity:vel];
        _duration = _timeRemaining = duration;
        [self setCollisionRadius:2.0];
        
        [color getRed:&_baseRGBA[0] green:&_baseRGBA[1] blue:&_baseRGBA[2] alpha:&_baseRGBA[3]];
        [self performUpdate:0]; // Handle colour mixing and such.
    }
    
    return self;
}

References _duration, _timeRemaining, OOColor::getRed:green:blue:alpha:, performUpdate:, Entity::setCollisionRadius:, Entity::setPosition:, and Entity::setVelocity:.

Here is the call graph for this function:

performUpdate:

- (void) performUpdate: (OOTimeDelta) delta_t

implementation

Provided by category OOSparkEntity(Private).

Definition at line 69 of file OOSparkEntity.m.

                      :(OOTimeDelta)delta_t
{
    _timeRemaining -= delta_t;
    
    float mix = OOClamp_0_1_f(_timeRemaining / _duration);
    
    // Fade towards red while fading out.
    _colorComponents[0] = mix * _baseRGBA[0] + (1.0f - mix);
    _colorComponents[1] = mix * _baseRGBA[1];
    _colorComponents[2] = mix * _baseRGBA[2];
    _colorComponents[3] = mix * _baseRGBA[3];
    
    // Disappear when gone.
    if (mix == 0)  [UNIVERSE removeEntity:self];
}

Referenced by initWithPosition:velocity:duration:size:color:, and update:.

Here is the caller graph for this function:

update:

- (void) update: (OOTimeDelta) delta_t

implementation

Reimplemented from Entity.

Definition at line 62 of file OOSparkEntity.m.

               :(OOTimeDelta)delta_t
{
    [super update:delta_t];
    [self performUpdate:delta_t];
}

References performUpdate:, and Entity::update:.

Here is the call graph for this function:

Member Data Documentation

_baseRGBA

- (GLfloat _baseRGBA[4])

private

Definition at line 32 of file OOSparkEntity.h.

_duration

- (GLfloat) _duration

private

Definition at line 33 of file OOSparkEntity.h.

Referenced by initWithPosition:velocity:duration:size:color:.

_timeRemaining

- (GLfloat) _timeRemaining

private

Definition at line 33 of file OOSparkEntity.h.

Referenced by initWithPosition:velocity:duration:size:color:.

---

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

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