OOLightParticleEntity Class Reference

#include <OOLightParticleEntity.h>

Inheritance diagram for OOLightParticleEntity:

Collaboration diagram for OOLightParticleEntity:

Instance Methods
(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)	- update:
(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

Class Methods
(void)	+ setUpTexture
(OOTexture *)	+ defaultParticleTexture
(void)	+ resetGraphicsState [implementation]

Protected Attributes
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

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 33 of file OOLightParticleEntity.h.

Method Documentation

allTextures

- (NSSet *) allTextures

implementation

Reimplemented from Entity.

Definition at line 42 of file OOLightParticleEntity.m.

{
    return [NSSet setWithObject:[self texture]];
}

canCollide

- (BOOL) canCollide

implementation

Reimplemented from Entity.

Reimplemented in OOPlasmaShotEntity.

Definition at line 42 of file OOLightParticleEntity.m.

{
    return NO;
}

defaultParticleTexture

+ (OOTexture *) defaultParticleTexture

Definition at line 42 of file OOLightParticleEntity.m.

{
    if (sBlobTexture == nil)  [self setUpTexture];
    return sBlobTexture;
}

diameter

- (float) diameter

Definition at line 42 of file OOLightParticleEntity.m.

{
    return _diameter;
}

drawImmediate:translucent:

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

implementation

Reimplemented from Entity.

Reimplemented in OOFlasherEntity.

Definition at line 42 of file OOLightParticleEntity.m.

                      :(bool)immediate translucent:(bool)translucent
{
    if (!translucent) return;
    if ([UNIVERSE breakPatternHide] && ![self isImmuneToBreakPatternHide])
    {
        Entity *father = [self owner];
        while (father != nil && father != NO_TARGET)
        {
            if (![father isSubEntity])  break;
            father = [father owner];
        }
        if (![father isImmuneToBreakPatternHide])
        {
            return;
        }
    }
    if (no_draw_distance <= cam_zero_distance)  return;
    
    OO_ENTER_OPENGL();
    OOSetOpenGLState(OPENGL_STATE_ADDITIVE_BLENDING);
    
    OOGL(glPushAttrib(GL_COLOR_BUFFER_BIT | GL_ENABLE_BIT));
    OOGL(glEnable(GL_BLEND));
    OOGL(glBlendFunc(GL_SRC_ALPHA, GL_ONE));
    
    OOGL(glEnable(GL_TEXTURE_2D));
    OOGL(glDepthMask(GL_FALSE));
    
    GLfloat distanceAttenuation = cam_zero_distance / no_draw_distance;
    distanceAttenuation = 1.0 - distanceAttenuation;
    GLfloat components[4] = { _colorComponents[0], _colorComponents[1], _colorComponents[2], _colorComponents[3] * distanceAttenuation };
    OOGL(glColor4fv(components));
    
    OOGL(glTexEnvfv(GL_TEXTURE_ENV, GL_TEXTURE_ENV_COLOR, components));
    OOGL(glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_BLEND));
    
    OOViewID viewDir = [UNIVERSE viewDirection];
    if (viewDir != VIEW_GUI_DISPLAY)  OOGLMultModelView([PLAYER drawRotationMatrix]);
    [[self texture] apply];
    
    /*  NOTE: nominal diameter is actual radius, because of the black border
        in the texture. However, the offset along the view axis is not
        affected by the border and needs to be scaled.
        -- Ahruman 2009-12-20
    */
    float viewOffset = _diameter * 0.5f;
    
    OOGLBEGIN(GL_QUADS);
    switch (viewDir)
    {
        case VIEW_FORWARD:
        case VIEW_GUI_DISPLAY:
            glTexCoord2f(0.0, 1.0);
            glVertex3f(-_diameter, -_diameter, -viewOffset);
            
            glTexCoord2f(1.0, 1.0);
            glVertex3f(_diameter, -_diameter, -viewOffset);
            
            glTexCoord2f(1.0, 0.0);
            glVertex3f(_diameter, _diameter, -viewOffset);
            
            glTexCoord2f(0.0, 0.0);
            glVertex3f(-_diameter, _diameter, -viewOffset);
            break;
            
        case VIEW_AFT:
            glTexCoord2f(0.0, 1.0);
            glVertex3f(_diameter, -_diameter, viewOffset);
            
            glTexCoord2f(1.0, 1.0);
            glVertex3f(-_diameter, -_diameter, viewOffset);
            
            glTexCoord2f(1.0, 0.0);
            glVertex3f(-_diameter, _diameter, viewOffset);
            
            glTexCoord2f(0.0, 0.0);
            glVertex3f(_diameter, _diameter, viewOffset);
            break;
            
        case VIEW_STARBOARD:
            glTexCoord2f(0.0, 1.0);
            glVertex3f(-viewOffset, -_diameter, _diameter);
            
            glTexCoord2f(1.0, 1.0);
            glVertex3f(-viewOffset, -_diameter, -_diameter);
            
            glTexCoord2f(1.0, 0.0);
            glVertex3f(-viewOffset, _diameter, -_diameter);
            
            glTexCoord2f(0.0, 0.0);
            glVertex3f(-viewOffset, _diameter, _diameter);
            break;
            
        case VIEW_PORT:
            glTexCoord2f(0.0, 1.0);
            glVertex3f(viewOffset, -_diameter, -_diameter);
            
            glTexCoord2f(1.0, 1.0);
            glVertex3f(viewOffset, -_diameter, _diameter);
            
            glTexCoord2f(1.0, 0.0);
            glVertex3f(viewOffset, _diameter, _diameter);
            
            glTexCoord2f(0.0, 0.0);
            glVertex3f(viewOffset, _diameter, -_diameter);
            break;
            
        case VIEW_CUSTOM:
            {
                PlayerEntity *player = PLAYER;
                Vector vi = [player customViewRightVector];     vi.x *= _diameter;  vi.y *= _diameter;  vi.z *= _diameter;
                Vector vj = [player customViewUpVector];        vj.x *= _diameter;  vj.y *= _diameter;  vj.z *= _diameter;
                Vector vk = [player customViewForwardVector];   vk.x *= viewOffset; vk.y *= viewOffset; vk.z *= viewOffset;
                glTexCoord2f(0.0, 1.0);
                glVertex3f(-vi.x -vj.x -vk.x, -vi.y -vj.y -vk.y, -vi.z -vj.z -vk.z);
                glTexCoord2f(1.0, 1.0);
                glVertex3f(+vi.x -vj.x -vk.x, +vi.y -vj.y -vk.y, +vi.z -vj.z -vk.z);
                glTexCoord2f(1.0, 0.0);
                glVertex3f(+vi.x +vj.x -vk.x, +vi.y +vj.y -vk.y, +vi.z +vj.z -vk.z);
                glTexCoord2f(0.0, 0.0);
                glVertex3f(-vi.x +vj.x -vk.x, -vi.y +vj.y -vk.y, -vi.z +vj.z -vk.z);
            }
            break;
            
        default:
            glTexCoord2f(0.0, 1.0);
            glVertex3f(-_diameter, -_diameter, -_diameter);
            
            glTexCoord2f(1.0, 1.0);
            glVertex3f(_diameter, -_diameter, -_diameter);
            
            glTexCoord2f(1.0, 0.0);
            glVertex3f(_diameter, _diameter, -_diameter);
            
            glTexCoord2f(0.0, 0.0);
            glVertex3f(-_diameter, _diameter, -_diameter);
            break;
    }
    OOGLEND();
    
    OOGL(glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE));
    OOGL(glPopAttrib());
    
    OOVerifyOpenGLState();
}

drawSubEntityImmediate:translucent:

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

Reimplemented from Entity.

Reimplemented in OOFlasherEntity.

Definition at line 42 of file OOLightParticleEntity.m.

                               :(bool)immediate translucent:(bool)translucent
{
    if (!translucent)  return;
    
    /*  TODO: someone will inevitably build a ship so big that individual
        zero_distances are necessary for flashers, if they haven't already.
        -- Ahruman 2009-09-20
    */
    cam_zero_distance = [[self owner] camZeroDistance];
    if (no_draw_distance <= cam_zero_distance)  return;
    
    Entity *father = [self owner];
    Entity *last = nil;
    HPVector abspos = position;
 
    while (father != nil && father != last && father != NO_TARGET)
    {
        OOMatrix rM = [father drawRotationMatrix];
        abspos = HPvector_add(OOHPVectorMultiplyMatrix(abspos, rM), [father position]);
        last = father;
        
        if (![father isSubEntity])  break;
        father = [father owner];
    }
 
    OOMatrix temp_matrix = OOGLPopModelView();
    OOGLPushModelView();
 
    /* Flashers are drawn using the absolute view matrix */
    OOGLLoadModelView([UNIVERSE viewMatrix]);
    /* ...modified by the aggregate translation calculated above */
    OOGLTranslateModelView(HPVectorToVector(HPvector_subtract(abspos,[PLAYER viewpointPosition]))); // move to camera-relative position 
    [self drawImmediate:immediate translucent:translucent];
 
    OOGLLoadModelView(temp_matrix);
}

initWithDiameter:

- (id) initWithDiameter:

(float)

diameter

Definition at line 42 of file OOLightParticleEntity.m.

                       :(float)diameter
{
    if ((self = [super init]))
    {
        _diameter = diameter;
        no_draw_distance = pow(diameter / 2.0, M_SQRT2) * NO_DRAW_DISTANCE_FACTOR * NO_DRAW_DISTANCE_FACTOR;
        no_draw_distance *= [UNIVERSE reducedDetail] ? PARTICLE_DISTANCE_SCALE_LOW : PARTICLE_DISTANCE_SCALE_HIGH;
        
        _colorComponents[0] = 1.0f;
        _colorComponents[1] = 1.0f;
        _colorComponents[2] = 1.0f;
        _colorComponents[3] = 1.0f;
        
        [self setScanClass:CLASS_NO_DRAW];
        [self setStatus:STATUS_EFFECT];
    }
    
    return self;
}

isEffect

- (BOOL) isEffect

implementation

Reimplemented from Entity.

Definition at line 42 of file OOLightParticleEntity.m.

{
    return YES;
}

resetGraphicsState

+ (void) resetGraphicsState

implementation

Reimplemented in OOFlashEffectEntity.

Provided by category OOLightParticleEntity(Private).

Definition at line 42 of file OOLightParticleEntity.m.

{
    [sBlobTexture release];
    sBlobTexture = nil;
}

setColor:

- (void) setColor:

(OOColor *)

color

Definition at line 42 of file OOLightParticleEntity.m.

                 :(OOColor *)color
{
    [color getRed:&_colorComponents[0] green:&_colorComponents[1] blue:&_colorComponents[2] alpha:&_colorComponents[3]];
}

Referenced by FlasherSetProperty().

Here is the caller graph for this function:

setColor:alpha:

- (void) setColor:		(OOColor *)	color
alpha:		(GLfloat)	alpha

Definition at line 42 of file OOLightParticleEntity.m.

                 :(OOColor *)color alpha:(GLfloat)alpha
{
    [self setColor:color];
    _colorComponents[3] = alpha;
}

setDiameter:

- (void) setDiameter:

(float)

diameter

Definition at line 42 of file OOLightParticleEntity.m.

                    :(float)diameter
{
    _diameter = diameter;
}

Referenced by FlasherSetProperty().

Here is the caller graph for this function:

setUpTexture

+ (void) setUpTexture

Reimplemented in OOFlashEffectEntity.

Definition at line 42 of file OOLightParticleEntity.m.

{
    if (sBlobTexture == nil)
    {
        sBlobTexture = [[OOTexture textureWithName:@"oolite-particle-blur.png"
                                          inFolder:@"Textures"
                                           options:kOOTextureMinFilterMipMap | kOOTextureMagFilterLinear | kOOTextureAlphaMask
                                        anisotropy:kOOTextureDefaultAnisotropy / 2.0
                                           lodBias:0.0] retain];
        [[OOGraphicsResetManager sharedManager] registerClient:(id<OOGraphicsResetClient>)[OOLightParticleEntity class]];
    }
}

texture

- (OOTexture *) texture

Reimplemented in OOFlashEffectEntity.

Definition at line 42 of file OOLightParticleEntity.m.

{
    return [OOLightParticleEntity defaultParticleTexture];
}

Member Data Documentation

_colorComponents

- (GLfloat _colorComponents[4])

protected

Definition at line 36 of file OOLightParticleEntity.h.

_diameter

- (float) _diameter

protected

Definition at line 37 of file OOLightParticleEntity.h.

---

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

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