OOExplosionCloudEntity Class Reference

#include <OOExplosionCloudEntity.h>

Inheritance diagram for OOExplosionCloudEntity:

Collaboration diagram for OOExplosionCloudEntity:

Instance Methods
(id)	- initExplosionCloudWithEntity:size:andSettings: [implementation]
(void)	- dealloc [implementation]
(void)	- update: [implementation]
(OOTexture *)	- texture [implementation]
Instance Methods inherited from OOParticleSystem
(id)	- initWithPosition:velocity:count:minSpeed:maxSpeed:duration:baseColor:
(id)	- init [implementation]
(NSString *)	- descriptionComponents [implementation]
(BOOL)	- canCollide [implementation]
(BOOL)	- checkCloseCollisionWith: [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
(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

Class Methods
(instancetype)	+ explosionCloudFromEntity:withSettings:
(instancetype)	+ explosionCloudFromEntity:withSize:andSettings:

Private Attributes
float	_growthRate
OOTimeDelta	_cloudDuration
float	_alpha
float	_brightnessMult
OOTexture *	_texture
NSDictionary *	_settings

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 OOParticleSystem
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

Detailed Description

Definition at line 30 of file OOExplosionCloudEntity.h.

Method Documentation

dealloc

- (void) dealloc

implementation

Reimplemented from Entity.

Definition at line 49 of file OOExplosionCloudEntity.m.

{
    DESTROY(_texture);
    DESTROY(_settings);
    [super dealloc];
}

explosionCloudFromEntity:withSettings:

+ (instancetype) explosionCloudFromEntity:		(Entity *)	entity
withSettings:		(NSDictionary *)	settings

Definition at line 49 of file OOExplosionCloudEntity.m.

                                         :(Entity *)entity withSettings:(NSDictionary *)settings
{
    return [[[self alloc] initExplosionCloudWithEntity:entity size:0 andSettings:settings] autorelease];
}

explosionCloudFromEntity:withSize:andSettings:

+ (instancetype) explosionCloudFromEntity:		(Entity *)	entity
withSize:		(float)	size
andSettings:		(NSDictionary *)	settings

Definition at line 49 of file OOExplosionCloudEntity.m.

                                         :(Entity *)entity withSize:(float)size andSettings:(NSDictionary *)settings
{
    return [[[self alloc] initExplosionCloudWithEntity:entity size:size andSettings:settings] autorelease];
}

initExplosionCloudWithEntity:size:andSettings:

- (id) initExplosionCloudWithEntity: (Entity *) entity size: (float) size andSettings: (NSDictionary *) settings

implementation

Provided by category OOExplosionCloudEntity(OOPrivate).

Definition at line 49 of file OOExplosionCloudEntity.m.

                                   :(Entity *)entity size:(float)size andSettings:(NSDictionary *)settings
{
    unsigned i;
    unsigned maxCount = [UNIVERSE detailLevel] <= DETAIL_LEVEL_SHADERS ? 10 : 25;
    HPVector pos = [entity position];
    Vector vel = [entity velocity];
 
    if (settings == nil) {
        _settings = [[NSDictionary dictionary] retain];
    } else {
        _settings = [settings retain];
    }
 
    unsigned count = [_settings oo_unsignedIntForKey:kExplosionCount defaultValue:25];
    if (count > maxCount) {
        count = maxCount;
    }
 
    if (size == 0.0) {
        size = [entity collisionRadius]*[_settings oo_floatForKey:kExplosionSize defaultValue:kExplosionDefaultSize];
    }
 
    _growthRate = [_settings oo_floatForKey:kExplosionGrowth defaultValue:kGrowthRateFactor] * size;
    _alpha = [_settings oo_floatForKey:kExplosionAlpha defaultValue:kExplosionCloudAlpha];
    _brightnessMult = [_settings oo_floatForKey:kExplosionBrightness defaultValue:kExplosionBrightnessMult];
    if (_brightnessMult < 1.0f)  _brightnessMult = 1.0f;
    _cloudDuration = [_settings oo_doubleForKey:kExplosionDuration defaultValue:kExplosionCloudDuration];
 
    GLfloat spread = [_settings oo_floatForKey:kExplosionSpread defaultValue:1.0];
 
    NSString *textureFile = [_settings oo_stringForKey:kExplosionTexture defaultValue:@"oolite-particle-cloud2.png"];
    
    _texture = [[OOTexture textureWithName:textureFile
                                  inFolder:@"Textures"
                                   options:kOOTextureMinFilterMipMap | kOOTextureMagFilterLinear | kOOTextureAlphaMask
                                anisotropy:kOOTextureDefaultAnisotropy
                                   lodBias:0.0] retain];    
    if (_texture == nil) 
    {
        [self release];
        return nil;
    }
 
    GLfloat baseColor[4] = {1.0,1.0,1.0,1.0};
 
    if (magnitude2(vel) > 1000000)
    {
        // slow down rapidly translating explosions
        vel = vector_multiply_scalar(vector_normal(vel),1000);
    }
 
    if ((self = [super initWithPosition:pos velocity:vel count:count minSpeed:size*0.8f*spread maxSpeed:size*1.2f*spread duration:_cloudDuration baseColor:baseColor]))
    {
        NSString *color_order = [_settings oo_stringForKey:kExplosionColors defaultValue:@"rgb"];
        
        for (i=0;i<count;i++) 
        {
            if ([color_order isEqualToString:@"white"]) {
                // grey
                _particleColor[i][0] = _particleColor[i][1] = _particleColor[i][2] = randf();
            } else {
                float c1 = randf();
                float c2 = randf();
                float c3 = randf();
                if (c2 > c1) {
                    c2 = c1;
                }
                if (c3 > c2) {
                    c3 = c2;
                }
                if ([color_order isEqualToString:@"rgb"]) 
                {
                    _particleColor[i][0] = c1;
                    _particleColor[i][1] = c2;
                    _particleColor[i][2] = c3;
                }
                else if ([color_order isEqualToString:@"rbg"]) 
                {
                    _particleColor[i][0] = c1;
                    _particleColor[i][1] = c3;
                    _particleColor[i][2] = c2;
                }
                else if ([color_order isEqualToString:@"grb"]) 
                {
                    _particleColor[i][0] = c2;
                    _particleColor[i][1] = c1;
                    _particleColor[i][2] = c3;
                }
                else if ([color_order isEqualToString:@"gbr"]) 
                {
                    _particleColor[i][0] = c3;
                    _particleColor[i][1] = c1;
                    _particleColor[i][2] = c2;
                }
                else if ([color_order isEqualToString:@"brg"]) 
                {
                    _particleColor[i][0] = c2;
                    _particleColor[i][1] = c3;
                    _particleColor[i][2] = c1;
                }
                else if ([color_order isEqualToString:@"bgr"]) 
                {
                    _particleColor[i][0] = c3;
                    _particleColor[i][1] = c2;
                    _particleColor[i][2] = c1;
                }
 
            }
            
            _particleColor[i][0] *= _brightnessMult;
            _particleColor[i][1] *= _brightnessMult;
            _particleColor[i][2] *= _brightnessMult;
            _particleColor[i][3] = _alpha;
        }
    }
    return self;
}

texture

- (OOTexture *) texture

implementation

Reimplemented from OOParticleSystem.

Definition at line 49 of file OOExplosionCloudEntity.m.

{
    return _texture;
}

update:

- (void) update: (OOTimeDelta) delta_t

implementation

Reimplemented from OOParticleSystem.

Definition at line 49 of file OOExplosionCloudEntity.m.

               :(OOTimeDelta)delta_t
{
    [super update:delta_t];
    
    // Fade out.
    GLfloat     fadeRate = _count * _brightnessMult / 25.0;
    unsigned    i, count = _count;
    GLfloat     (*particleColor)[4] = _particleColor;
    
    float newAlpha = _alpha * (1-(_timePassed / _cloudDuration));
    NSString *color_order = [_settings oo_stringForKey:kExplosionColors defaultValue:@"rgb"];
    NSUInteger primary = 0, secondary = 1, tertiary = 2;
            
    if ([color_order isEqualToString:@"rgb"]) 
    {
        primary = 0;
        secondary = 1;
        tertiary = 2;
    }
    else if ([color_order isEqualToString:@"rbg"]) 
    {
        primary = 0;
        secondary = 2;
        tertiary = 1;
    }
    else if ([color_order isEqualToString:@"grb"]) 
    {
        primary = 1;
        secondary = 0;
        tertiary = 2;
    }
    else if ([color_order isEqualToString:@"gbr"]) 
    {
        primary = 1;
        secondary = 2;
        tertiary = 0;
    }
    else if ([color_order isEqualToString:@"brg"]) 
    {
        primary = 2;
        secondary = 0;
        tertiary = 1;
    }
    else if ([color_order isEqualToString:@"bgr"]) 
    {
        primary = 2;
        secondary = 1;
        tertiary = 0;
    }
 
 
    float fdelta_t = delta_t;
    for (i=0;i<count;i++) {
        
        _particleSize[i] += delta_t * _growthRate;
 
        particleColor[i][3] = newAlpha;
        if (![color_order isEqualToString:@"white"])
        {
 
            if (particleColor[i][tertiary] > 0.0f) // fade blue (white to yellow)
            {
                particleColor[i][tertiary] -= fdelta_t * 0.5f * fadeRate;
                if (particleColor[i][tertiary] < 0.0f)
                {
                    particleColor[i][tertiary] = 0.0f;
                }
            }
            else if (particleColor[i][secondary] > 0.0f) // fade green (yellow to red)
            {
                particleColor[i][secondary] -= fdelta_t * fadeRate;
                if (particleColor[i][secondary] < 0.0f)
                {
                    particleColor[i][secondary] = 0.0f;
                }
            }
            else if (particleColor[i][primary] > 0.0f) // fade red (red to black)
            {
                particleColor[i][primary] -= fdelta_t * 2.0f * fadeRate;
                if (particleColor[i][primary] < 0.0f)
                {
                    particleColor[i][primary] = 0.0f;
                }
            }
 
        }
    }
    
}

Member Data Documentation

_alpha

- (float) _alpha

private

Definition at line 35 of file OOExplosionCloudEntity.h.

_brightnessMult

- (float) _brightnessMult

private

Definition at line 36 of file OOExplosionCloudEntity.h.

_cloudDuration

- (OOTimeDelta) _cloudDuration

private

Definition at line 34 of file OOExplosionCloudEntity.h.

_growthRate

- (float) _growthRate

private

Definition at line 33 of file OOExplosionCloudEntity.h.

_settings

- (NSDictionary*) _settings

private

Definition at line 38 of file OOExplosionCloudEntity.h.

_texture

- (OOTexture*) _texture

private

Definition at line 37 of file OOExplosionCloudEntity.h.

---

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

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