OOParticleSystem Class Reference

#include <OOParticleSystem.h>

Inheritance diagram for OOParticleSystem:

Collaboration diagram for OOParticleSystem:

Instance Methods
(id)	- initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:
(OOTexture *)	- texture
(id)	- init [implementation]
(NSString *)	- descriptionComponents [implementation]
(BOOL)	- canCollide [implementation]
(BOOL)	- checkCloseCollisionWith: [implementation]
(void)	- update: [implementation]
(void)	- drawImmediate:translucent: [implementation]
(BOOL)	- isEffect [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:
(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
(void)	- dealloc [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:
(void)	- drawSubEntityImmediate:translucent: [implementation]
Instance Methods inherited from OOWeakRefObject
(id)	- weakSelf
(id)	- weakRetain [implementation]
(void)	- weakRefDied: [implementation]
Instance Methods inherited from <OOWeakReferenceSupport>
(id)	- OO_RETURNS_RETAINED

Protected Attributes
Vector	_particlePosition [kFragmentBurstMaxParticles]
Vector	_particleVelocity [kFragmentBurstMaxParticles]
GLfloat	_particleColor [kFragmentBurstMaxParticles][4]
GLfloat	_particleSize [kFragmentBurstMaxParticles]
unsigned	_count
unsigned	_particleType
OOTimeDelta	_timePassed
OOTimeDelta	_duration
double	_maxSpeed
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

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

Detailed Description

Definition at line 41 of file OOParticleSystem.h.

Method Documentation

allTextures

- (NSSet *) allTextures

implementation

Reimplemented from Entity.

Definition at line 252 of file OOParticleSystem.m.

{
    return [NSSet setWithObject:[OOLightParticleEntity defaultParticleTexture]];
}

References allTextures, and OOLightParticleEntity::defaultParticleTexture.

Referenced by allTextures.

Here is the call graph for this function:

Here is the caller graph for this function:

canCollide

- (BOOL) canCollide

implementation

Reimplemented from Entity.

Definition at line 99 of file OOParticleSystem.m.

{
    return NO;
}

References canCollide.

Referenced by canCollide.

Here is the call graph for this function:

Here is the caller graph for this function:

checkCloseCollisionWith:

- (BOOL) checkCloseCollisionWith: (Entity *) other

implementation

Reimplemented from Entity.

Definition at line 105 of file OOParticleSystem.m.

                                :(Entity *)other
{
    if (other == [self owner])  return NO;
    return ![other isEffect];
}

References Entity::isEffect, and Entity::owner.

Here is the call graph for this function:

descriptionComponents

- (NSString *) descriptionComponents

implementation

Reimplemented from Entity.

Definition at line 93 of file OOParticleSystem.m.

{
    return [NSString stringWithFormat:@"ttl: %.3fs", _duration - _timePassed];
}

References descriptionComponents.

Referenced by descriptionComponents.

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 Entity.

Definition at line 142 of file OOParticleSystem.m.

                      :(bool)immediate translucent:(bool)translucent
{
    if (!translucent || [UNIVERSE breakPatternHide])  return;
 
    OO_ENTER_OPENGL();
    OOSetOpenGLState(OPENGL_STATE_ADDITIVE_BLENDING);
    
    OOGL(glPushAttrib(GL_ENABLE_BIT | GL_COLOR_BUFFER_BIT));
    
    OOGL(glEnable(GL_TEXTURE_2D));
    OOGL(glEnable(GL_BLEND));
    OOGL(glBlendFunc(GL_SRC_ALPHA, GL_ONE));
    [[self texture] apply];
    
    HPVector        viewPosition = [PLAYER viewpointPosition];
    HPVector        selfPosition = [self position];
    
    unsigned    i, count = _count;
    Vector      *particlePosition = _particlePosition;
    GLfloat     (*particleColor)[4] = _particleColor;
    GLfloat     *particleSize = _particleSize;
    
    if ([UNIVERSE reducedDetail])
    {
        // Quick rendering - particle cloud is effectively a 2D billboard.
        OOGLPushModelView();
        OOGLMultModelView(OOMatrixForBillboard(selfPosition, viewPosition));
        
        OOGLBEGIN(GL_QUADS);
        for (i = 0; i < count; i++)
        {
            glColor4fv(particleColor[i]);
            DrawQuadForView(particlePosition[i].x, particlePosition[i].y, particlePosition[i].z, particleSize[i]);
        }
        OOGLEND();
        
        OOGLPopModelView();
    }
    else
    {
        float distanceThreshold = collision_radius * 2.0f;  // Distance between player and middle of effect where we start to transition to "non-fast rendering."
        float thresholdSq = distanceThreshold * distanceThreshold;
        float distanceSq = cam_zero_distance;
        
        if (distanceSq > thresholdSq)
        {
            /*  Semi-quick rendering - particle positions are volumetric, but
                orientation is shared. This can cause noticeable distortion
                if the player is close to the centre of the cloud.
            */
            OOMatrix bbMatrix = OOMatrixForBillboard(selfPosition, viewPosition);
            
            for (i = 0; i < count; i++)
            {
                OOGLPushModelView();
                OOGLTranslateModelView(particlePosition[i]);
                OOGLMultModelView(bbMatrix);
                
                glColor4fv(particleColor[i]);
                OOGLBEGIN(GL_QUADS);
                    DrawQuadForView(0, 0, 0, particleSize[i]);
                OOGLEND();
                
                OOGLPopModelView();
            }
        }
        else
        {
            /*  Non-fast rendering - each particle is billboarded individually.
                The "individuality" factor interpolates between this behavior
                and "semi-quick" to avoid jumping at the boundary.
            */
            float individuality = 3.0f * (1.0f - distanceSq / thresholdSq);
            individuality = OOClamp_0_1_f(individuality);
            
            for (i = 0; i < count; i++)
            {
                OOGLPushModelView();
                OOGLTranslateModelView(particlePosition[i]);
                OOGLMultModelView(OOMatrixForBillboard(HPvector_add(selfPosition, vectorToHPVector(vector_multiply_scalar(particlePosition[i], individuality))), viewPosition));
                
                glColor4fv(particleColor[i]);
                OOGLBEGIN(GL_QUADS);
                DrawQuadForView(0, 0, 0, particleSize[i]);
                OOGLEND();
                
                OOGLPopModelView();
            }
        }
 
    }
    
    OOGL(glPopAttrib());
    
    OOVerifyOpenGLState();
    OOCheckOpenGLErrors(@"OOParticleSystem after drawing %@", self);
}

References _count, _particleColor, _particlePosition, _particleSize, OOTexture::apply, Entity::cam_zero_distance, Entity::collision_radius, count, DrawQuadForView, OO_ENTER_OPENGL, OOCheckOpenGLErrors(), OOGL, OOGLBEGIN, OOGLEND, OOGLMultModelView(), OOGLPopModelView(), OOGLPushModelView(), OOGLTranslateModelView(), OOMatrixForBillboard(), OOSetOpenGLState, OOVerifyOpenGLState, OPENGL_STATE_ADDITIVE_BLENDING, Entity::position, texture, UNIVERSE, x, and y.

Here is the call graph for this function:

init

- (id) init

implementation

Reimplemented from Entity.

Definition at line 41 of file OOParticleSystem.m.

{
    [self release];
    return nil;
}

References init, and nil.

Referenced by init, and initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:.

Here is the call graph for this function:

Here is the caller graph for this function:

initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:

- (id) initWithPosition:		(HPVector)	position
velocity:		(Vector)	velocity
count:		(unsigned)	count
minSpeed:		(float)	minSpeed
maxSpeed:		(float)	maxSpeed
duration:		(OOTimeDelta)	duration
baseColor:		(GLfloat[4])	baseColor

Definition at line 51 of file OOParticleSystem.m.

                       :(HPVector)pos
               velocity:(Vector)vel
                  count:(unsigned)count
               minSpeed:(float)minSpeed
               maxSpeed:(float)maxSpeed
               duration:(OOTimeDelta)duration
              baseColor:(GLfloat[4])baseColor
{
    NSParameterAssert(count <= kFragmentBurstMaxParticles);
    
    if ((self = [super init]))
    {
        _count = count;
        [self setPosition:pos];
        
        velocity = vel;
        _duration = duration;
        _maxSpeed = maxSpeed;
        
        for (unsigned i = 0; i < count; i++)
        {
            GLfloat speed = minSpeed + 0.5f * (randf()+randf()) * (maxSpeed - minSpeed); // speed tends toward middle of range
            _particleVelocity[i] = vector_multiply_scalar(OORandomUnitVector(), speed);
            
            Vector color = make_vector(baseColor[0] * 0.1f * (9.5f + randf()), baseColor[1] * 0.1f * (9.5f + randf()), baseColor[2] * 0.1f * (9.5f + randf()));
            color = vector_normal(color);
            _particleColor[i][0] = color.x;
            _particleColor[i][1] = color.y;
            _particleColor[i][2] = color.z;
            _particleColor[i][3] = baseColor[3];
            
            _particleSize[i] = speed;
        }
        
        [self setStatus:STATUS_EFFECT];
        scanClass = CLASS_NO_DRAW;
    }
    
    return self;
}

References _count, _duration, _maxSpeed, _particleColor, _particleSize, _particleVelocity, baseColor, count, init, kFragmentBurstMaxParticles, maxSpeed, OORandomUnitVector(), randf(), Entity::scanClass, Entity::setPosition:, Entity::setStatus:, Entity::speed, and Entity::velocity.

Here is the call graph for this function:

isEffect

- (BOOL) isEffect

implementation

Reimplemented from Entity.

Definition at line 241 of file OOParticleSystem.m.

{
    return YES;
}

References isEffect.

Referenced by isEffect.

Here is the call graph for this function:

Here is the caller graph for this function:

texture

- (OOTexture *) texture

Reimplemented in OOExplosionCloudEntity.

Definition at line 246 of file OOParticleSystem.m.

{
    return [OOLightParticleEntity defaultParticleTexture];
}

References OOLightParticleEntity::defaultParticleTexture, and texture.

Referenced by drawImmediate:translucent:, and texture.

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.

Reimplemented in OOBigFragmentBurstEntity, OOExplosionCloudEntity, and OOSmallFragmentBurstEntity.

Definition at line 112 of file OOParticleSystem.m.

               :(OOTimeDelta) delta_t
{
    [super update:delta_t];
    
    _timePassed += delta_t;
    collision_radius += delta_t * _maxSpeed;
    
    unsigned    i, count = _count;
    Vector      *particlePosition = _particlePosition;
    Vector      *particleVelocity = _particleVelocity;
    
    for (i = 0; i < count; i++)
    {
        particlePosition[i] = vector_add(particlePosition[i], vector_multiply_scalar(particleVelocity[i], delta_t));
    }
    
    // disappear eventually.
    if (_timePassed > _duration)  [UNIVERSE removeEntity:self];
}

References _count, _duration, _maxSpeed, _particlePosition, _particleVelocity, _timePassed, Entity::collision_radius, count, and Entity::update:.

Referenced by OOBigFragmentBurstEntity::update:, OOExplosionCloudEntity::update:, and OOSmallFragmentBurstEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_count

- (unsigned) _count

protected

Definition at line 48 of file OOParticleSystem.h.

Referenced by drawImmediate:translucent:, initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:, OOBigFragmentBurstEntity::update:, OOExplosionCloudEntity::update:, update:, and OOSmallFragmentBurstEntity::update:.

_duration

- (OOTimeDelta) _duration

protected

Definition at line 52 of file OOParticleSystem.h.

Referenced by initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:, OOBigFragmentBurstEntity::update:, and update:.

_maxSpeed

- (double) _maxSpeed

protected

Definition at line 53 of file OOParticleSystem.h.

Referenced by initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:, and update:.

_particleColor

- (GLfloat _particleColor[kFragmentBurstMaxParticles][4])

protected

Definition at line 46 of file OOParticleSystem.h.

Referenced by drawImmediate:translucent:, initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:, OOBigFragmentBurstEntity::update:, OOExplosionCloudEntity::update:, and OOSmallFragmentBurstEntity::update:.

_particlePosition

- (Vector _particlePosition[kFragmentBurstMaxParticles])

protected

Definition at line 44 of file OOParticleSystem.h.

Referenced by drawImmediate:translucent:, and update:.

_particleSize

- (GLfloat _particleSize[kFragmentBurstMaxParticles])

protected

Definition at line 47 of file OOParticleSystem.h.

Referenced by drawImmediate:translucent:, OOBigFragmentBurstEntity::if, OOSmallFragmentBurstEntity::if, initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:, OOBigFragmentBurstEntity::update:, and OOExplosionCloudEntity::update:.

_particleType

- (unsigned) _particleType

protected

Definition at line 50 of file OOParticleSystem.h.

_particleVelocity

- (Vector _particleVelocity[kFragmentBurstMaxParticles])

protected

Definition at line 45 of file OOParticleSystem.h.

Referenced by initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:, and update:.

_timePassed

- (OOTimeDelta) _timePassed

protected

Definition at line 52 of file OOParticleSystem.h.

Referenced by OOBigFragmentBurstEntity::update:, OOExplosionCloudEntity::update:, update:, and OOSmallFragmentBurstEntity::update:.

---

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

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