OOLaserShotEntity Class Reference

#include <OOLaserShotEntity.h>

Inheritance diagram for OOLaserShotEntity:

Collaboration diagram for OOLaserShotEntity:

Instance Methods
(void)	- setColor:
(void)	- setRange:
(OOTexture *)	- texture1
(OOTexture *)	- texture2
(instancetype)	- initLaserFromShip:direction:offset: [implementation]
(void)	- dealloc [implementation]
(NSString *)	- descriptionComponents [implementation]
(void)	- update: [implementation]
(void)	- drawImmediate:translucent: [implementation]
(BOOL)	- isEffect [implementation]
(BOOL)	- canCollide [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
(NSSet *)	- allTextures
(id)	- init [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

Class Methods
(instancetype)	+ laserFromShip:direction:offset:
(void)	+ setUpTexture
(OOTexture *)	+ innerTexture
(OOTexture *)	+ outerTexture
(void)	+ resetGraphicsState [implementation]

Private Attributes
GLfloat	_color [4]
OOTimeDelta	_lifetime
GLfloat	_range
Vector	_offset
Quaternion	_relOrientation

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 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 36 of file OOLaserShotEntity.h.

Method Documentation

canCollide

- (BOOL) canCollide

implementation

Reimplemented from Entity.

Definition at line 263 of file OOLaserShotEntity.m.

{
    return NO;
}

References canCollide.

Referenced by canCollide.

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 128 of file OOLaserShotEntity.m.

{
    [self setColor:nil];
    
    [super dealloc];
}

References Entity::dealloc, dealloc, and setColor:.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

descriptionComponents

- (NSString *) descriptionComponents

implementation

Reimplemented from Entity.

Definition at line 136 of file OOLaserShotEntity.m.

{
    return [NSString stringWithFormat:@"ttl: %.3fs - %@ orientation %@", _lifetime, [super descriptionComponents], QuaternionDescription([self orientation])];
}

References Entity::descriptionComponents, descriptionComponents, and Entity::orientation.

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 196 of file OOLaserShotEntity.m.

                      :(bool)immediate translucent:(bool)translucent
{
    if (!translucent || [UNIVERSE breakPatternHide])  return;
 
    OO_ENTER_OPENGL();
    OOSetOpenGLState(OPENGL_STATE_ADDITIVE_BLENDING);
    
 
    /*  FIXME: spread damage across the lifetime of the shot,
        hurting whatever is hit in a given frame.
        -- Ahruman 2011-01-31
    */
    OOGL(glEnableClientState(GL_TEXTURE_COORD_ARRAY));
    OOGL(glEnable(GL_TEXTURE_2D));
    OOGLPushModelView();
    
    OOGLScaleModelView(make_vector(kLaserHalfWidth, kLaserHalfWidth, _range));
    [[self texture1] apply];
    GLfloat s = sinf([UNIVERSE getTime]);
    GLfloat phase = s*(_range/200.0f);
    GLfloat phase2 = (1.0f+s)*(_range/200.0f);
    GLfloat phase3 = -s*(_range/500.0f);
    GLfloat phase4 = -(1.0f+s)*(_range/500.0f);
 
    GLfloat laserTexCoords[] = 
        {
            0.0f, phase,    0.0f, phase2,   1.0f, phase2,   1.0f, phase,
 
            0.0f, phase,    0.0f, phase2,   1.0f, phase2,   1.0f, phase
        };
    GLfloat laserTexCoords2[] = 
        {
            0.0f, phase3,   0.0f, phase4,   1.0f, phase4,   1.0f, phase3,
 
            0.0f, phase3,   0.0f, phase4,   1.0f, phase4,   1.0f, phase3
        };
    
    OOGL(glColor4fv(_color));
    glVertexPointer(3, GL_FLOAT, 0, kLaserVertices);
    glTexCoordPointer(2, GL_FLOAT, 0, laserTexCoords2);
    glDrawArrays(GL_QUADS, 0, 8);
    
    OOGLScaleModelView(make_vector(kLaserCoreWidth / kLaserHalfWidth, kLaserCoreWidth / kLaserHalfWidth, 1.0));
    OOGL(glColor4f(kLaserBrightness,kLaserBrightness,kLaserBrightness,0.9));
    glDrawArrays(GL_QUADS, 0, 8);
 
    [[self texture2] apply];
    OOGLScaleModelView(make_vector(kLaserFlareWidth / kLaserCoreWidth, kLaserFlareWidth / kLaserCoreWidth, 1.0));
    OOGL(glColor4f(_color[0],_color[1],_color[2],0.9));
    glTexCoordPointer(2, GL_FLOAT, 0, laserTexCoords);
    glDrawArrays(GL_QUADS, 0, 8);
    
    OOGLPopModelView();
    OOGL(glDisableClientState(GL_TEXTURE_COORD_ARRAY));
    OOGL(glDisable(GL_TEXTURE_2D));
    
    OOVerifyOpenGLState();
    OOCheckOpenGLErrors(@"OOLaserShotEntity after drawing %@", self);
}

References _color, _range, OOTexture::apply, kLaserBrightness, kLaserCoreWidth, kLaserFlareWidth, kLaserHalfWidth, kLaserVertices, OO_ENTER_OPENGL, OOCheckOpenGLErrors(), OOGL, OOGLPopModelView(), OOGLPushModelView(), OOGLScaleModelView(), OOSetOpenGLState, OOVerifyOpenGLState, OPENGL_STATE_ADDITIVE_BLENDING, texture1, texture2, and UNIVERSE.

Here is the call graph for this function:

initLaserFromShip:direction:offset:

- (instancetype) initLaserFromShip: (ShipEntity *) srcEntity direction: (OOWeaponFacing) direction offset: (Vector) offset

implementation

Definition at line 59 of file OOLaserShotEntity.m.

                                  :(ShipEntity *)srcEntity direction:(OOWeaponFacing)direction offset:(Vector)offset
{
    if (!(self = [super init]))  return nil;
    
    ShipEntity          *ship = [srcEntity rootShipEntity];
    Vector              middle = OOBoundingBoxCenter([srcEntity boundingBox]);
    
    NSCParameterAssert([srcEntity isShip] && [ship isShip]);
    
    [self setStatus:STATUS_EFFECT];
    
    if (ship == srcEntity) 
    {
        // main laser offset
        [self setPosition:HPvector_add([ship position], vectorToHPVector(OOVectorMultiplyMatrix(offset, [ship drawRotationMatrix])))];
    }
    else
    {
        // subentity laser
        [self setPosition:[srcEntity absolutePositionForSubentityOffset:vectorToHPVector(middle)]];
    }
    
    Quaternion q = kIdentityQuaternion;
    Vector q_up = vector_up_from_quaternion(q);
    Quaternion q0 = [ship normalOrientation];
    velocity = vector_multiply_scalar(vector_forward_from_quaternion(q0), [ship flightSpeed]);
    
    switch (direction)
    {
        case WEAPON_FACING_NONE:
        case WEAPON_FACING_FORWARD:
            break;
            
        case WEAPON_FACING_AFT:
            quaternion_rotate_about_axis(&q, q_up, M_PI);
            break;
            
        case WEAPON_FACING_PORT:
            quaternion_rotate_about_axis(&q, q_up, M_PI/2.0);
            break;
            
        case WEAPON_FACING_STARBOARD:
            quaternion_rotate_about_axis(&q, q_up, -M_PI/2.0);
            break;
    }
    
    [self setOrientation:quaternion_multiply(q,q0)];
    [self setOwner:ship];
    [self setRange:[srcEntity weaponRange]];
    _lifetime = kLaserDuration;
    
    _color[0] = kLaserRed/3.0;
    _color[1] = kLaserGreen/3.0;
    _color[2] = kLaserBlue/3.0;
    _color[3] = kLaserAlpha;
 
    _offset = (ship == srcEntity) ? offset : middle;
    _relOrientation = q;
    
    return self;
}

References _color, _lifetime, _offset, _relOrientation, Entity::absolutePositionForSubentityOffset:, Entity::boundingBox, Entity::drawRotationMatrix, Entity::init, Entity::isShip, kIdentityQuaternion, kLaserAlpha, kLaserBlue, kLaserDuration, kLaserGreen, kLaserRed, M_PI, nil, Entity::normalOrientation, Entity::position, quaternion_rotate_about_axis(), Entity::rootShipEntity, Entity::setOrientation:, Entity::setOwner:, Entity::setPosition:, setRange:, Entity::setStatus:, vector_forward_from_quaternion(), vector_up_from_quaternion(), Entity::velocity, WEAPON_FACING_AFT, WEAPON_FACING_FORWARD, WEAPON_FACING_NONE, WEAPON_FACING_PORT, WEAPON_FACING_STARBOARD, and ShipEntity::weaponRange.

Here is the call graph for this function:

innerTexture

+ (OOTexture *) innerTexture

Definition at line 300 of file OOLaserShotEntity.m.

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

References innerTexture, nil, setUpTexture, and sShotTexture2.

Referenced by innerTexture, and texture2.

Here is the call graph for this function:

Here is the caller graph for this function:

isEffect

- (BOOL) isEffect

implementation

Reimplemented from Entity.

Definition at line 257 of file OOLaserShotEntity.m.

{
    return YES;
}

References isEffect.

Referenced by isEffect.

Here is the call graph for this function:

Here is the caller graph for this function:

laserFromShip:direction:offset:

+ (instancetype) laserFromShip:		(ShipEntity *)	ship
direction:		(OOWeaponFacing)	direction
offset:		(Vector)	offset

Definition at line 122 of file OOLaserShotEntity.m.

                              :(ShipEntity *)ship direction:(OOWeaponFacing)direction offset:(Vector)offset
{
    return [[[self alloc] initLaserFromShip:ship direction:direction offset:offset] autorelease];
}

Referenced by ShipEntity::fireDirectLaserShotAt:, ShipEntity::fireLaserShotInDirection:weaponIdentifier:, and ShipEntity::fireSubentityLaserShot:.

Here is the caller graph for this function:

outerTexture

+ (OOTexture *) outerTexture

Definition at line 307 of file OOLaserShotEntity.m.

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

References nil, outerTexture, setUpTexture, and sShotTexture.

Referenced by outerTexture, and texture1.

Here is the call graph for this function:

Here is the caller graph for this function:

resetGraphicsState

+ (void) resetGraphicsState

implementation

Definition at line 314 of file OOLaserShotEntity.m.

{
    [sShotTexture release];
    sShotTexture = nil;
    [sShotTexture2 release];
    sShotTexture2 = nil;
}

References nil, OOTexture::release, resetGraphicsState, sShotTexture, and sShotTexture2.

Referenced by resetGraphicsState.

Here is the call graph for this function:

Here is the caller graph for this function:

setColor:

- (void) setColor:

(OOColor *)

color

Definition at line 142 of file OOLaserShotEntity.m.

                 :(OOColor *)color
{
    _color[0] = kLaserBrightness * [color redComponent]/3.0;
    _color[1] = kLaserBrightness * [color greenComponent]/3.0;
    _color[2] = kLaserBrightness * [color blueComponent]/3.0;
    // Ignore alpha; _color[3] is constant.
}

References _color, OOColor::blueComponent, OOColor::greenComponent, kLaserBrightness, and OOColor::redComponent.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

setRange:

- (void) setRange:

(GLfloat)

range

Definition at line 151 of file OOLaserShotEntity.m.

                 :(GLfloat)range
{
    _range = range;
    [self setCollisionRadius:range];
}

References _range, and Entity::setCollisionRadius:.

Referenced by initLaserFromShip:direction:offset:.

Here is the call graph for this function:

Here is the caller graph for this function:

setUpTexture

+ (void) setUpTexture

Definition at line 280 of file OOLaserShotEntity.m.

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

References nil, OOGraphicsResetManager::registerClient:, setUpTexture, OOGraphicsResetManager::sharedManager, sShotTexture, sShotTexture2, and OOTexture::textureWithName:inFolder:options:anisotropy:lodBias:.

Referenced by innerTexture, outerTexture, and setUpTexture.

Here is the call graph for this function:

Here is the caller graph for this function:

texture1

- (OOTexture *) texture1

Definition at line 268 of file OOLaserShotEntity.m.

{
    return [OOLaserShotEntity outerTexture];
}

References outerTexture, and texture1.

Referenced by drawImmediate:translucent:, and texture1.

Here is the call graph for this function:

Here is the caller graph for this function:

texture2

- (OOTexture *) texture2

Definition at line 274 of file OOLaserShotEntity.m.

{
    return [OOLaserShotEntity innerTexture];
}

References innerTexture, and texture2.

Referenced by drawImmediate:translucent:, and texture2.

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 158 of file OOLaserShotEntity.m.

               :(OOTimeDelta)delta_t
{
    [super update:delta_t];
    _lifetime -= delta_t;
    ShipEntity      *ship = [self owner];
    
    if ([ship isPlayer]) 
    {
        /*
            Reposition this shot accurately. This overrides integration over
            velocity in -[Entity update:], which is considered sufficient for
            NPC ships.
        */
        [self setPosition:HPvector_add([ship position], vectorToHPVector(OOVectorMultiplyMatrix(_offset, [ship drawRotationMatrix])))];
        [self setOrientation:quaternion_multiply(_relOrientation, [ship normalOrientation])];
    }
 
    if (_lifetime < 0)  
    {
        [UNIVERSE removeEntity:self];
    }
}

References _lifetime, Entity::drawRotationMatrix, Entity::isPlayer, Entity::normalOrientation, Entity::owner, Entity::position, Entity::setOrientation:, Entity::setPosition:, and Entity::update:.

Referenced by PlayerEntity::doBookkeeping:.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_color

- (GLfloat _color[4])

private

Definition at line 39 of file OOLaserShotEntity.h.

Referenced by drawImmediate:translucent:, initLaserFromShip:direction:offset:, and setColor:.

_lifetime

- (OOTimeDelta) _lifetime

private

Definition at line 40 of file OOLaserShotEntity.h.

Referenced by initLaserFromShip:direction:offset:, and update:.

_offset

- (Vector) _offset

private

Definition at line 42 of file OOLaserShotEntity.h.

Referenced by initLaserFromShip:direction:offset:.

_range

- (GLfloat) _range

private

Definition at line 41 of file OOLaserShotEntity.h.

Referenced by drawImmediate:translucent:, and setRange:.

_relOrientation

- (Quaternion) _relOrientation

private

Definition at line 43 of file OOLaserShotEntity.h.

Referenced by initLaserFromShip:direction:offset:.

---

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

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