#include <Entity.h>

Inheritance diagram for Entity:

Collaboration diagram for Entity:

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

(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

(BOOL)	- canCollide

(GLfloat)	- collisionRadius

(GLfloat)	- frustumRadius

(void)	- setCollisionRadius:

(NSMutableArray *)	- collisionArray

(void)	- update:

(void)	- applyVelocity:

(BOOL)	- checkCloseCollisionWith:

(void)	- takeEnergyDamage:from:becauseOf:weaponIdentifier:

(void)	- dumpState

(void)	- dumpSelfState

(NSUInteger)	- lastDrawCounter

(void)	- setLastDrawCounter:

(double)	- findCollisionRadius

(void)	- drawImmediate:translucent:

(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]`

(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

(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

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

NSUInteger	lastDrawCounter

Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Private Attributes
NSUInteger	_sessionID

OOWeakReference *	_owner

OOEntityStatus	_status

Detailed Description

Definition at line 78 of file Entity.h.

Method Documentation

◆ absolutePositionForSubentity

- (HPVector) absolutePositionForSubentity

Definition at line 55 of file Entity.m.

{
    return [self absolutePositionForSubentityOffset:kZeroHPVector];
}

Referenced by ShipEntity::absoluteIJKForSubentity.

Here is the caller graph for this function:

◆ absolutePositionForSubentityOffset:

- (HPVector) absolutePositionForSubentityOffset: (HPVector) offset

Definition at line 55 of file Entity.m.

                                               :(HPVector) offset
{
    HPVector        abspos = HPvector_add(position, OOHPVectorMultiplyMatrix(offset, rotMatrix));
    Entity      *last = nil;
    Entity      *father = [self parentEntity];
    
    while (father != nil && father != last)
    {
        abspos = HPvector_add(OOHPVectorMultiplyMatrix(abspos, [father drawRotationMatrix]), [father position]);
        last = father;
        if (![last isSubEntity]) break;
        father = [father owner];
    }
    return abspos;
}

Referenced by OOLaserShotEntity::dealloc.

Here is the caller graph for this function:

◆ addToLinkedLists

- (void) addToLinkedLists

Definition at line 55 of file Entity.m.

{
#ifndef NDEBUG
    if (gDebugFlags & DEBUG_LINKED_LISTS)
        OOLog(kOOLogEntityAddToList, @"DEBUG adding entity %@ to linked lists", self);
#endif
    //
    // insert at the start
    if (UNIVERSE)
    {
        x_previous = nil; x_next = UNIVERSE->x_list_start;
        // move UP the list
        while ((x_next)&&(x_next->position.x - x_next->collision_radius < position.x - collision_radius))
        {
            x_previous = x_next;
            x_next = x_next->x_next;
        }   
        if (x_next)     x_next->x_previous = self;
        if (x_previous) x_previous->x_next = self;
        else            UNIVERSE->x_list_start = self;
        
        y_previous = nil; y_next = UNIVERSE->y_list_start;
        // move UP the list
        while ((y_next)&&(y_next->position.y - y_next->collision_radius < position.y - collision_radius))
        {
            y_previous = y_next;
            y_next = y_next->y_next;
        }   
        if (y_next)     y_next->y_previous = self;
        if (y_previous) y_previous->y_next = self;
        else            UNIVERSE->y_list_start = self;
 
        z_previous = nil; z_next = UNIVERSE->z_list_start;
        // move UP the list
        while ((z_next)&&(z_next->position.z - z_next->collision_radius < position.z - collision_radius))
        {
            z_previous = z_next;
            z_next = z_next->z_next;
        }   
        if (z_next)     z_next->z_previous = self;
        if (z_previous) z_previous->z_next = self;
        else            UNIVERSE->z_list_start = self;
                
    }
    
#ifndef NDEBUG
    if (gDebugFlags & DEBUG_LINKED_LISTS)
    {
        if (![self checkLinkedLists])
        {
            OOLog(kOOLogEntityAddToListError, @"DEBUG LINKED LISTS - problem encountered while adding %@ to linked lists", self);
            [UNIVERSE debugDumpEntities];
        }
    }
#endif
}

Referenced by Universe::addEntity:.

Here is the caller graph for this function:

◆ allTextures

- (NSSet *) allTextures

Reimplemented in OOEntityWithDrawable, OOLightParticleEntity, and OOParticleSystem.

Definition at line 55 of file Entity.m.

{
    return nil;
}

◆ applyRoll:andClimb:

- (void) applyRoll:	(GLfloat)	roll
andClimb:	(GLfloat)	climb

Reimplemented in PlayerEntity, and ShipEntity.

Definition at line 55 of file Entity.m.

                  :(GLfloat) roll andClimb:(GLfloat) climb
{
    if ((roll == 0.0)&&(climb == 0.0)&&(!hasRotated))
        return;
 
    if (roll)
        quaternion_rotate_about_z(&orientation, -roll);
    if (climb)
        quaternion_rotate_about_x(&orientation, -climb);
    
    [self orientationChanged];
}

◆ applyRoll:climb:andYaw:

- (void) applyRoll:	(GLfloat)	roll
climb:	(GLfloat)	climb
andYaw:	(GLfloat)	yaw

Reimplemented in ShipEntity.

Definition at line 55 of file Entity.m.

                  :(GLfloat) roll climb:(GLfloat) climb andYaw:(GLfloat) yaw
{
    if ((roll == 0.0)&&(climb == 0.0)&&(yaw == 0.0)&&(!hasRotated))
        return;
 
    if (roll)
        quaternion_rotate_about_z(&orientation, -roll);
    if (climb)
        quaternion_rotate_about_x(&orientation, -climb);
    if (yaw)
        quaternion_rotate_about_y(&orientation, -yaw);
 
    [self orientationChanged];
}

◆ applyVelocity:

- (void) applyVelocity: (OOTimeDelta) delta_t

Definition at line 55 of file Entity.m.

                      :(OOTimeDelta)delta_t
{
    position = HPvector_add(position, HPvector_multiply_scalar(vectorToHPVector(velocity), delta_t));
}

◆ boundingBox

- (BoundingBox) boundingBox

◆ cameraRangeBack

- (GLfloat) cameraRangeBack

Reimplemented in SkyEntity.

Definition at line 55 of file Entity.m.

{
    return magnitude(cameraRelativePosition) + [self frustumRadius];
}

◆ cameraRangeFront

- (GLfloat) cameraRangeFront

Reimplemented in SkyEntity.

Definition at line 55 of file Entity.m.

{
    return magnitude(cameraRelativePosition) - [self frustumRadius];
}

◆ cameraRelativePosition

- (Vector) cameraRelativePosition

◆ camZeroDistance

- (double) camZeroDistance

Definition at line 55 of file Entity.m.

{
    return cam_zero_distance;
}

◆ canCollide

- (BOOL) canCollide

Reimplemented in DustEntity, OOBreakPatternEntity, OOLaserShotEntity, OOLightParticleEntity, OOParticleSystem, OOPlasmaShotEntity, OOQuiriumCascadeEntity, OORingEffectEntity, OOSunEntity, OOVisualEffectEntity, PlayerEntity, ShipEntity, SkyEntity, and WormholeEntity.

Definition at line 55 of file Entity.m.

{
    return YES;
}

◆ checkCloseCollisionWith:

- (BOOL) checkCloseCollisionWith: (Entity *) other

Reimplemented in OOParticleSystem, OOPlanetEntity, OOPlasmaShotEntity, OOQuiriumCascadeEntity, OOSunEntity, ShipEntity, and WormholeEntity.

Definition at line 55 of file Entity.m.

                                :(Entity *)other
{
    return other != nil;
}

◆ checkLinkedLists

- (BOOL) checkLinkedLists

implementation

Provided by category Entity(OOPrivate).

Definition at line 55 of file Entity.m.

{
    // DEBUG check for loops
    if (UNIVERSE->n_entities > 0)
    {
        int n;
        Entity  *check, *last;
        //
        last = nil;
        //
        n = UNIVERSE->n_entities;
        check = UNIVERSE->x_list_start;
        while ((n--)&&(check))
        {
            last = check;
            check = check->x_next;
        }
        if ((check)||(n > 0))
        {
            OOLog(kOOLogEntityVerificationError, @"Broken x_next %@ list (%d) ***", UNIVERSE->x_list_start, n);
            return NO;
        }
        //
        n = UNIVERSE->n_entities;
        check = last;
        while ((n--)&&(check))  check = check->x_previous;
        if ((check)||(n > 0))
        {
            OOLog(kOOLogEntityVerificationError, @"Broken x_previous %@ list (%d) ***", UNIVERSE->x_list_start, n);
            return NO;
        }
        //
        n = UNIVERSE->n_entities;
        check = UNIVERSE->y_list_start;
        while ((n--)&&(check))
        {
            last = check;
            check = check->y_next;
        }
        if ((check)||(n > 0))
        {
            OOLog(kOOLogEntityVerificationError, @"Broken y_next %@ list (%d) ***", UNIVERSE->y_list_start, n);
            return NO;
        }
        //
        n = UNIVERSE->n_entities;
        check = last;
        while ((n--)&&(check))  check = check->y_previous;
        if ((check)||(n > 0))
        {
            OOLog(kOOLogEntityVerificationError, @"Broken y_previous %@ list (%d) ***", UNIVERSE->y_list_start, n);
            return NO;
        }
        //
        n = UNIVERSE->n_entities;
        check = UNIVERSE->z_list_start;
        while ((n--)&&(check))
        {
            last = check;
            check = check->z_next;
        }
        if ((check)||(n > 0))
        {
            OOLog(kOOLogEntityVerificationError, @"Broken z_next %@ list (%d) ***", UNIVERSE->z_list_start, n);
            return NO;
        }
        //
        n = UNIVERSE->n_entities;
        check = last;
        while ((n--)&&(check))  check = check->z_previous;
        if ((check)||(n > 0))
        {
            OOLog(kOOLogEntityVerificationError, @"Broken z_previous %@ list (%d) ***", UNIVERSE->z_list_start, n);
            return NO;
        }
    }
    return YES;
}

◆ clock

- (GLfloat) clock

implementation

Provided by category Entity(ShaderBindings).

Definition at line 1 of file EntityShaderBindings.m.

{
    return [PLAYER clockTime];
}

◆ collisionArray

- (NSMutableArray *) collisionArray

Definition at line 55 of file Entity.m.

{
    return collidingEntities;
}

◆ collisionRadius

- (GLfloat) collisionRadius

Reimplemented in OOVisualEffectEntity.

Definition at line 55 of file Entity.m.

{
    return collision_radius;
}

Referenced by HeadUpDisplay::hudDrawReticleOnTarget.

Here is the caller graph for this function:

◆ collisionRegion

- (CollisionRegion *) collisionRegion

◆ compareZeroDistance:

- (NSComparisonResult) compareZeroDistance: (Entity *) otherEntity

Reimplemented in PlayerEntity.

Definition at line 55 of file Entity.m.

                                          :(Entity *)otherEntity
{
    if ((otherEntity)&&(zero_distance > otherEntity->zero_distance))
        return NSOrderedAscending;
    else
        return NSOrderedDescending;
}

◆ dealloc

- (void) dealloc

implementation

Reimplemented from OOWeakRefObject.

Reimplemented in DockEntity, DustEntity, OOEntityWithDrawable, OOExplosionCloudEntity, OOFlasherEntity, OOLaserShotEntity, OOPlanetEntity, OOSunEntity, OOVisualEffectEntity, OOWaypointEntity, PlayerEntity, ShipEntity, SkyEntity, StationEntity, and WormholeEntity.

Definition at line 55 of file Entity.m.

{
    [UNIVERSE ensureEntityReallyRemoved:self];
    DESTROY(collidingEntities);
    DESTROY(collisionRegion);
    [self deleteJSSelf];
    [self setOwner:nil];
    [atmosphereFogging release];
    
#ifndef NDEBUG
    gLiveEntityCount--;
    gTotalEntityMemory -= [self oo_objectSize];
#endif
    
    [super dealloc];
}

Referenced by OOEntityWithDrawable::allTextures.

Here is the caller graph for this function:

◆ deleteJSSelf

- (void) deleteJSSelf

Provided by category Entity(OOJavaScriptExtensions).

Definition at line 1 of file EntityOOJavaScriptExtensions.m.

{
    if (_jsSelf != NULL)
    {
        _jsSelf = NULL;
        JSContext *context = OOJSAcquireContext();
        JS_RemoveObjectRoot(context, &_jsSelf);
        OOJSRelinquishContext(context);
        
        [[NSNotificationCenter defaultCenter] removeObserver:self
                                                        name:kOOJavaScriptEngineWillResetNotification
                                                      object:[OOJavaScriptEngine sharedEngine]];
    }
}

◆ descriptionComponents

- (NSString *) descriptionComponents

implementation

Reimplemented in OOLaserShotEntity, OOParticleSystem, OOPlanetEntity, OOQuiriumCascadeEntity, OORingEffectEntity, OOSunEntity, ShipEntity, StationEntity, and WormholeEntity.

Definition at line 55 of file Entity.m.

{
    return [NSString stringWithFormat:@"position: %@ scanClass: %@ status: %@", HPVectorDescription([self position]), OOStringFromScanClass([self scanClass]), OOStringFromEntityStatus([self status])];
}

◆ descriptionForObjDump

- (NSString *) descriptionForObjDump

Reimplemented in DustEntity, ShipEntity, and SkyEntity.

Definition at line 55 of file Entity.m.

{
    NSString *result = [self descriptionForObjDumpBasic];
    
    result = [result stringByAppendingFormat:@" range: %g (visible: %@)", HPdistance([self position], [PLAYER position]), [self isVisible] ? @"yes" : @"no"];
    
    return result;
}

◆ descriptionForObjDumpBasic

- (NSString *) descriptionForObjDumpBasic

Definition at line 55 of file Entity.m.

{
    NSString *result = [self descriptionComponents];
    if (result != nil)  result = [NSString stringWithFormat:@"%@ %@", NSStringFromClass([self class]), result];
    else  result = [self description];
    
    return result;
}

◆ distanceTravelled

- (GLfloat) distanceTravelled

◆ drawImmediate:translucent:

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

Reimplemented in DockEntity, DustEntity, OOBreakPatternEntity, OOECMBlastEntity, OOEntityWithDrawable, OOFlasherEntity, OOLaserShotEntity, OOLightParticleEntity, OOParticleSystem, OOPlanetEntity, OOQuiriumCascadeEntity, OORingEffectEntity, OOSunEntity, OOVisualEffectEntity, OOWaypointEntity, PlayerEntity, ShipEntity, SkyEntity, and WormholeEntity.

Definition at line 55 of file Entity.m.

                      :(bool)immediate translucent:(bool)translucent
{
    OOLogGenericSubclassResponsibility();
}

◆ drawRotationMatrix

- (OOMatrix) drawRotationMatrix

Reimplemented in PlayerEntity.

Definition at line 55 of file Entity.m.

{
    return rotMatrix;
}

Referenced by OOLaserShotEntity::dealloc.

Here is the caller graph for this function:

◆ drawSubEntityImmediate:translucent:

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

implementation

Reimplemented in OOExhaustPlumeEntity, OOFlasherEntity, OOVisualEffectEntity, ShipEntity, and OOLightParticleEntity.

Provided by category Entity(SubEntityRelationship).

Definition at line 14062 of file ShipEntity.m.

                               :(bool)immediate translucent:(bool)translucent
{
    // Do nothing.
}

◆ drawTransformationMatrix

- (OOMatrix) drawTransformationMatrix

Reimplemented in PlayerEntity.

Definition at line 55 of file Entity.m.

{
    OOMatrix result = rotMatrix;
    return OOMatrixHPTranslate(result, position);
}

◆ dumpSelfState

- (void) dumpSelfState

Reimplemented in PlayerEntity, ShipEntity, StationEntity, and WormholeEntity.

Definition at line 55 of file Entity.m.

{
    NSMutableArray      *flags = nil;
    NSString            *flagsString = nil;
    id                  owner = [self owner];
    
    if (owner == self)  owner = @"self";
    else if (owner == nil)  owner = @"none";
    
    OOLog(@"dumpState.entity", @"Universal ID: %u", universalID);
    OOLog(@"dumpState.entity", @"Scan class: %@", OOStringFromScanClass(scanClass));
    OOLog(@"dumpState.entity", @"Status: %@", OOStringFromEntityStatus([self status]));
    OOLog(@"dumpState.entity", @"Position: %@", HPVectorDescription(position));
    OOLog(@"dumpState.entity", @"Orientation: %@", QuaternionDescription(orientation));
    OOLog(@"dumpState.entity", @"Distance travelled: %g", distanceTravelled);
    OOLog(@"dumpState.entity", @"Energy: %g of %g", energy, maxEnergy);
    OOLog(@"dumpState.entity", @"Mass: %g", mass);
    OOLog(@"dumpState.entity", @"Owner: %@", owner);
    
    flags = [NSMutableArray array];
    #define ADD_FLAG_IF_SET(x)      if (x) { [flags addObject:@#x]; }
    ADD_FLAG_IF_SET(isShip);
    ADD_FLAG_IF_SET(isStation);
    ADD_FLAG_IF_SET(isPlayer);
    ADD_FLAG_IF_SET(isWormhole);
    ADD_FLAG_IF_SET(isSubEntity);
    ADD_FLAG_IF_SET(hasMoved);
    ADD_FLAG_IF_SET(hasRotated);
    ADD_FLAG_IF_SET(isSunlit);
    ADD_FLAG_IF_SET(throw_sparks);
    flagsString = [flags count] ? [flags componentsJoinedByString:@", "] : (NSString *)@"none";
    OOLog(@"dumpState.entity", @"Flags: %@", flagsString);
    OOLog(@"dumpState.entity", @"Collision Test Filter: %u", collisionTestFilter);
 
}

◆ dumpState

- (void) dumpState

Definition at line 55 of file Entity.m.

{
    if (OOLogWillDisplayMessagesInClass(@"dumpState"))
    {
        OOLog(@"dumpState", @"State for %@:", self);
        OOLogPushIndent();
        OOLogIndent();
        @try
        {
            [self dumpSelfState];
        }
        @catch (id exception) {}
        OOLogPopIndent();
    }
}

◆ energy

- (GLfloat) energy

◆ findCollisionRadius

- (double) findCollisionRadius

Reimplemented in OOEntityWithDrawable, OOExhaustPlumeEntity, and OOFlasherEntity.

Definition at line 55 of file Entity.m.

{
    OOLogGenericSubclassResponsibility();
    return 0;
}

◆ fogUniform

- (OOColor *) fogUniform

Definition at line 55 of file Entity.m.

{
    return [[atmosphereFogging retain] autorelease];
}

◆ frustumRadius

- (GLfloat) frustumRadius

Reimplemented in OOVisualEffectEntity, and ShipEntity.

Definition at line 55 of file Entity.m.

{
    return collision_radius;
}

◆ getJSClass:andPrototype:

- (void) getJSClass:	(JSClass **)	outClass
andPrototype:	(JSObject **)	outPrototype

Reimplemented in ShipEntity, DockEntity, OOPlanetEntity, StationEntity, OOSunEntity, OOExhaustPlumeEntity, OOFlasherEntity, OOVisualEffectEntity, OOWaypointEntity, and WormholeEntity.

Provided by category Entity(OOJavaScriptExtensions).

Definition at line 1 of file EntityOOJavaScriptExtensions.m.

                   :(JSClass **)outClass andPrototype:(JSObject **)outPrototype
{
    *outClass = JSEntityClass();
    *outPrototype = JSEntityPrototype();
}

◆ init

- (id) init

implementation

Reimplemented in DustEntity, OOParticleSystem, OOSunEntity, OOVisualEffectEntity, PlayerEntity, ShipEntity, and WormholeEntity.

Definition at line 55 of file Entity.m.

{
    self = [super init];
    if (EXPECT_NOT(self == nil))  return nil;
    
    _sessionID = [UNIVERSE sessionID];
    
    orientation = kIdentityQuaternion;
    rotMatrix = kIdentityMatrix;
    position = kZeroHPVector;
    
    no_draw_distance = 100000.0;  //  10 km
    
    collidingEntities = [[NSMutableArray alloc] init];
    
    scanClass = CLASS_NOT_SET;
    [self setStatus:STATUS_COCKPIT_DISPLAY];
    
    spawnTime = [UNIVERSE getTime];
    
    isSunlit = YES;
 
    atmosphereFogging = [[OOColor colorWithRed: 0.0 green: 0.0 blue: 0.0 alpha: 0.0] retain];
    
#ifndef NDEBUG
    gLiveEntityCount++;
    gTotalEntityMemory += [self oo_objectSize];
#endif
    
    lastDrawCounter = 0;
    return self;
}

Referenced by OOLaserShotEntity::dealloc, and OOPlanetEntity::initFromDictionary:withAtmosphere:andSeed:forSystem:.

Here is the caller graph for this function:

◆ inspect

- (void) inspect

implementation

Provided by category Entity(OODebugInspector).

Referenced by ConsoleInspectEntity().

Here is the caller graph for this function:

◆ isBreakPattern

- (BOOL) isBreakPattern

Reimplemented in OOBreakPatternEntity, and OOVisualEffectEntity.

Provided by category Entity(OOBreakPatternEntity).

Definition at line 1 of file OOBreakPatternEntity.m.

{
    return NO;
}

◆ isCascadeWeapon

- (BOOL) isCascadeWeapon

Reimplemented in OOQuiriumCascadeEntity.

Provided by category Entity(OOQuiriumCascadeExtensions).

Definition at line 1 of file OOQuiriumCascadeEntity.m.

{
    return NO;
}

◆ isDock

- (BOOL) isDock

Reimplemented in DockEntity.

Definition at line 55 of file Entity.m.

{
    return NO;
}

◆ isECMBlast

- (BOOL) isECMBlast

Reimplemented in OOECMBlastEntity.

Provided by category Entity(OOECMBlastEntity).

Definition at line 1 of file OOECMBlastEntity.m.

{
    return NO;
}

◆ isEffect

- (BOOL) isEffect

Reimplemented in OOLaserShotEntity, OOLightParticleEntity, OOParticleSystem, OOQuiriumCascadeEntity, OORingEffectEntity, OOVisualEffectEntity, and OOWaypointEntity.

Definition at line 55 of file Entity.m.

{
    return NO;
}

◆ isExhaust

- (BOOL) isExhaust

Reimplemented in OOExhaustPlumeEntity.

Provided by category Entity(OOExhaustPlume).

Definition at line 380 of file OOExhaustPlumeEntity.m.

{
    return NO;
}

◆ isFlasher

- (BOOL) isFlasher

Reimplemented in OOFlasherEntity.

Provided by category Entity(OOFlasherEntityExtensions).

Definition at line 1 of file OOFlasherEntity.m.

{
    return NO;
}

◆ isImmuneToBreakPatternHide

- (BOOL) isImmuneToBreakPatternHide

◆ isInSpace

- (BOOL) isInSpace

Definition at line 55 of file Entity.m.

{
    switch ([self status])
    {
    case STATUS_IN_FLIGHT:
    case STATUS_DOCKING:
    case STATUS_LAUNCHING:
    case STATUS_AUTOPILOT_ENGAGED:
    case STATUS_WITCHSPACE_COUNTDOWN:
    case STATUS_BEING_SCOOPED:
    case STATUS_EFFECT:
    case STATUS_ACTIVE:
        return YES;
    default:
        return NO;
    }
}

◆ isPlanet

- (BOOL) isPlanet

Reimplemented in OOPlanetEntity.

Definition at line 55 of file Entity.m.

{
    return NO;
}

◆ isPlayer

- (BOOL) isPlayer

◆ isPlayerLikeShip

- (BOOL) isPlayerLikeShip

Reimplemented in PlayerEntity, and ProxyPlayerEntity.

Provided by category Entity(ProxyPlayer).

Definition at line 1 of file ProxyPlayerEntity.m.

{
    return NO;
}

◆ isShip

- (BOOL) isShip

◆ isShipWithSubEntityShip:

- (BOOL) isShipWithSubEntityShip: (Entity *) other

Reimplemented in OOVisualEffectEntity, and ShipEntity.

Provided by category Entity(SubEntityRelationship).

Definition at line 14062 of file ShipEntity.m.

                                :(Entity *)other
{
    return NO;
}

◆ isSky

- (BOOL) isSky

Reimplemented in SkyEntity.

Definition at line 55 of file Entity.m.

{
    return NO;
}

◆ isStation

- (BOOL) isStation

◆ isStellarObject

- (BOOL) isStellarObject

Definition at line 55 of file Entity.m.

{
    return [self isPlanet] || [self isSun];
}

◆ isSubEntity

- (BOOL) isSubEntity

◆ isSun

- (BOOL) isSun

Reimplemented in OOSunEntity.

Definition at line 55 of file Entity.m.

{
    return NO;
}

Referenced by IsSunPredicate().

Here is the caller graph for this function:

◆ isSunlit

- (BOOL) isSunlit

◆ isVisible

- (BOOL) isVisible

Reimplemented in OOPlanetEntity, OOSunEntity, ShipEntity, and SkyEntity.

Definition at line 55 of file Entity.m.

{
    return cam_zero_distance <= ABSOLUTE_NO_DRAW_DISTANCE2;
}

◆ isVisibleToScripts

- (BOOL) isVisibleToScripts

Reimplemented in ShipEntity, OOExhaustPlumeEntity, OOFlasherEntity, OOPlanetEntity, OOSunEntity, OOVisualEffectEntity, OOWaypointEntity, and WormholeEntity.

Provided by category Entity(OOJavaScriptExtensions).

Definition at line 1 of file EntityOOJavaScriptExtensions.m.

{
    return NO;
}

Referenced by JSEntityIsJavaScriptVisiblePredicate().

Here is the caller graph for this function:

◆ isVisualEffect

- (BOOL) isVisualEffect

Reimplemented in OOVisualEffectEntity.

◆ isWaypoint

- (BOOL) isWaypoint

Reimplemented in OOWaypointEntity.

Definition at line 55 of file Entity.m.

{
    return NO;
}

◆ isWormhole

- (BOOL) isWormhole

◆ lastDrawCounter

- (NSUInteger) lastDrawCounter

◆ mass

- (GLfloat) mass

◆ maxEnergy

- (GLfloat) maxEnergy

◆ moveForward:

- (void) moveForward: (double) amount

Reimplemented in PlayerEntity.

Definition at line 55 of file Entity.m.

                    :(double)amount
{
    HPVector forward = HPvector_multiply_scalar(HPvector_forward_from_quaternion(orientation), amount);
    position = HPvector_add(position, forward);
    distanceTravelled += amount;
}

◆ normalOrientation

- (Quaternion) normalOrientation

Reimplemented in PlayerEntity.

Definition at line 55 of file Entity.m.

{
    return [self orientation];
}

Referenced by OOLaserShotEntity::dealloc.

Here is the caller graph for this function:

◆ oo_jsClassName

- (NSString *) oo_jsClassName

Reimplemented in ShipEntity, DockEntity, OOExhaustPlumeEntity, OOFlasherEntity, OOPlanetEntity, PlayerEntity, StationEntity, OOSunEntity, OOVisualEffectEntity, OOWaypointEntity, and WormholeEntity.

Provided by category Entity(OOJavaScriptExtensions).

Definition at line 1 of file EntityOOJavaScriptExtensions.m.

{
    return @"Entity";
}

◆ oo_jsValueInContext:

- (jsval) oo_jsValueInContext: (JSContext *) context

implementation

Provided by category Entity(OOJavaScriptExtensions).

Definition at line 1 of file EntityOOJavaScriptExtensions.m.

                             :(JSContext *)context
{
    JSClass                 *class = NULL;
    JSObject                *prototype = NULL;
    jsval                   result = JSVAL_NULL;
    
    if (_jsSelf == NULL && [self isVisibleToScripts])
    {
        // Create JS object
        [self getJSClass:&class andPrototype:&prototype];
        
        _jsSelf = JS_NewObject(context, class, prototype, NULL);
        if (_jsSelf != NULL)
        {
            if (!JS_SetPrivate(context, _jsSelf, OOConsumeReference([self weakRetain])))  _jsSelf = NULL;
        }
        
        if (_jsSelf != NULL)
        {
            OOJSAddGCObjectRoot(context, &_jsSelf, "Entity jsSelf");
            [[NSNotificationCenter defaultCenter] addObserver:self
                                                     selector:@selector(deleteJSSelf)
                                                         name:kOOJavaScriptEngineWillResetNotification
                                                       object:[OOJavaScriptEngine sharedEngine]];
        }
    }
    
    if (_jsSelf != NULL)  result = OBJECT_TO_JSVAL(_jsSelf);
    
    return result;
    // Analyzer: object leaked. [Expected, object is retained by JS object.]
}

Referenced by JSFunctionPredicate(), and MissionRunScreen().

Here is the caller graph for this function:

◆ orientation

- (Quaternion) orientation

◆ orientationChanged

- (void) orientationChanged

Reimplemented in OOVisualEffectEntity, PlayerEntity, and ShipEntity.

Definition at line 55 of file Entity.m.

{
    quaternion_normalize(&orientation);
    rotMatrix = OOMatrixForQuaternionRotation(orientation);
}

◆ owner

- (id) owner

Definition at line 55 of file Entity.m.

{
    return [_owner weakRefUnderlyingObject];
}

Referenced by EntityGetProperty(), OOExhaustPlumeEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, OOFlasherEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, and VisualEffectRemove().

Here is the caller graph for this function:

◆ parentEntity

- (ShipEntity *) parentEntity

Definition at line 55 of file Entity.m.

{
    id owner = [self owner];
    if ([owner isShipWithSubEntityShip:self])  return owner;
    return nil;
}

◆ position

- (HPVector) position

◆ pseudoFixedD100

- (unsigned) pseudoFixedD100

implementation

Provided by category Entity(ShaderBindings).

Definition at line 1 of file EntityShaderBindings.m.

{
    return [PLAYER systemPseudoRandom100];
}

◆ pseudoFixedD256

- (unsigned) pseudoFixedD256

implementation

Provided by category Entity(ShaderBindings).

Definition at line 1 of file EntityShaderBindings.m.

{
    return [PLAYER systemPseudoRandom256];
}

◆ relativePosition

- (Vector) relativePosition

implementation

Definition at line 55 of file Entity.m.

{
    return HPVectorToVector(HPvector_subtract([self position], [PLAYER position]));
}

◆ removeFromLinkedLists

- (void) removeFromLinkedLists

Definition at line 55 of file Entity.m.

{
#ifndef NDEBUG
    if (gDebugFlags & DEBUG_LINKED_LISTS)
        OOLog(kOOLogEntityRemoveFromList, @"DEBUG removing entity %@ from linked lists", self);
#endif
    
    if ((x_next == nil)&&(x_previous == nil))   // removed already!
        return;
 
    // make sure the starting point is still correct
    if (UNIVERSE)
    {
        if ((UNIVERSE->x_list_start == self)&&(x_next))
                UNIVERSE->x_list_start = x_next;
        if ((UNIVERSE->y_list_start == self)&&(y_next))
                UNIVERSE->y_list_start = y_next;
        if ((UNIVERSE->z_list_start == self)&&(z_next))
                UNIVERSE->z_list_start = z_next;
    }
    //
    if (x_previous)     x_previous->x_next = x_next;
    if (x_next)         x_next->x_previous = x_previous;
    //
    if (y_previous)     y_previous->y_next = y_next;
    if (y_next)         y_next->y_previous = y_previous;
    //
    if (z_previous)     z_previous->z_next = z_next;
    if (z_next)         z_next->z_previous = z_previous;
    //
    x_previous = nil;   x_next = nil;
    y_previous = nil;   y_next = nil;
    z_previous = nil;   z_next = nil;
 
#ifndef NDEBUG
    if (gDebugFlags & DEBUG_LINKED_LISTS)
    {
        if (![self checkLinkedLists])
        {
            OOLog(kOOLogEntityRemoveFromListError, @"DEBUG LINKED LISTS - problem encountered while removing %@ from linked lists", self);
            [UNIVERSE debugDumpEntities];
        }
    }
#endif
}

◆ rootShipEntity

- (ShipEntity *) rootShipEntity

Definition at line 55 of file Entity.m.

{
    ShipEntity *parent = [self parentEntity];
    if (parent != nil)  return [parent rootShipEntity];
    if ([self isShip])  return (ShipEntity *)self;
    return nil;
}

Referenced by OOLaserShotEntity::dealloc.

Here is the caller graph for this function:

◆ rotationMatrix

- (OOMatrix) rotationMatrix

Definition at line 55 of file Entity.m.

{
    return rotMatrix;
}

◆ scanClass

- (OOScanClass) scanClass

Reimplemented in ShipEntity.

◆ sessionID

- (NSUInteger) sessionID

Reimplemented in PlayerEntity.

Definition at line 55 of file Entity.m.

{
    return _sessionID;
}

◆ setAtmosphereFogging:

- (void) setAtmosphereFogging: (OOColor *) fogging

Definition at line 55 of file Entity.m.

                             : (OOColor *)fogging
{
    [atmosphereFogging release];
    atmosphereFogging = [fogging retain];
}

◆ setCollisionRadius:

- (void) setCollisionRadius: (GLfloat) amount

Definition at line 55 of file Entity.m.

                           :(GLfloat) amount
{
    collision_radius = amount;
}

◆ setCollisionRegion:

- (void) setCollisionRegion: (CollisionRegion*) region

Definition at line 55 of file Entity.m.

                           : (CollisionRegion*) region
{
    if (collisionRegion) [collisionRegion release];
    collisionRegion = [region retain];
}

◆ setDistanceTravelled:

- (void) setDistanceTravelled: (GLfloat) value

Definition at line 55 of file Entity.m.

                             : (GLfloat) value
{
    distanceTravelled = value;
}

◆ setEnergy:

- (void) setEnergy: (GLfloat) amount

Definition at line 55 of file Entity.m.

                  :(GLfloat) amount
{
    energy = amount;
}

Referenced by EntitySetProperty().

Here is the caller graph for this function:

◆ setLastDrawCounter:

- (void) setLastDrawCounter: (NSUInteger) drawCounter

Definition at line 55 of file Entity.m.

                           : (NSUInteger) drawCounter
{
    lastDrawCounter = drawCounter;
    return;
}

◆ setMaxEnergy:

- (void) setMaxEnergy: (GLfloat) amount

Definition at line 55 of file Entity.m.

                     :(GLfloat)amount
{
    maxEnergy = amount;
}

Referenced by EntitySetProperty().

Here is the caller graph for this function:

◆ setNormalOrientation:

- (void) setNormalOrientation: (Quaternion) quat

Reimplemented in PlayerEntity.

Definition at line 55 of file Entity.m.

                             :(Quaternion) quat
{
    [self setOrientation:quat];
}

Referenced by EntitySetProperty(), and OOWaypointEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:.

Here is the caller graph for this function:

◆ setOrientation:

- (void) setOrientation: (Quaternion) quat

Reimplemented in OOWaypointEntity, and OOPlanetEntity.

Definition at line 55 of file Entity.m.

                       :(Quaternion) quat
{
    orientation = quat;
    [self orientationChanged];
}

Referenced by OOLaserShotEntity::dealloc.

Here is the caller graph for this function:

◆ setOwner:

- (void) setOwner: (Entity *) ent

Reimplemented in ShipEntity.

Definition at line 55 of file Entity.m.

                 :(Entity *)ent
{
    [_owner release];
    _owner = [ent weakRetain];
}

Referenced by OOLaserShotEntity::dealloc.

Here is the caller graph for this function:

◆ setPosition:

- (void) setPosition: (HPVector) posn

Reimplemented in OOSunEntity.

Definition at line 55 of file Entity.m.

                    :(HPVector) posn
{
    position = posn;
    [self updateCameraRelativePosition];
}

Referenced by OOLaserShotEntity::dealloc, and EntitySetProperty().

Here is the caller graph for this function:

◆ setPositionX:y:z:

- (void) setPositionX:	(OOHPScalar)	x
y:	(OOHPScalar)	y
z:	(OOHPScalar)	z

Definition at line 55 of file Entity.m.

                     :(OOHPScalar)x y:(OOHPScalar)y z:(OOHPScalar)z
{
    position.x = x;
    position.y = y;
    position.z = z;
    [self updateCameraRelativePosition];
}

◆ setScanClass:

- (void) setScanClass: (OOScanClass) sClass

Definition at line 55 of file Entity.m.

                     :(OOScanClass)sClass
{
    scanClass = sClass;
}

Referenced by EntitySetProperty().

Here is the caller graph for this function:

◆ setStatus:

- (void) setStatus: (OOEntityStatus) stat

Reimplemented in ShipEntity.

Definition at line 55 of file Entity.m.

                  :(OOEntityStatus) stat
{
    _status = stat;
}

Referenced by WormholeEntity::arrivalTime, OOLaserShotEntity::dealloc, and OOPlanetEntity::initFromDictionary:withAtmosphere:andSeed:forSystem:.

Here is the caller graph for this function:

◆ setThrowSparks:

- (void) setThrowSparks: (BOOL) value

Definition at line 55 of file Entity.m.

                       :(BOOL) value
{
    throw_sparks = value;
}

◆ setUniversalID:

- (void) setUniversalID: (OOUniversalID) uid

Definition at line 55 of file Entity.m.

                       :(OOUniversalID)uid
{
    universalID = uid;
}

◆ setVelocity:

- (void) setVelocity: (Vector) vel

Definition at line 55 of file Entity.m.

                    :(Vector) vel
{
    velocity = vel;
}

◆ spawnTime

- (GLfloat) spawnTime

◆ speed

- (double) speed

Definition at line 55 of file Entity.m.

{
    return magnitude([self velocity]);
}

◆ status

- (OOEntityStatus) status

Definition at line 55 of file Entity.m.

{
    return _status;
}

Referenced by EntityGetProperty(), and PlayerShipBeginGalacticHyperspaceCountdown().

Here is the caller graph for this function:

◆ subEntityReallyDied:

- (void) subEntityReallyDied: (ShipEntity *) sub

implementation

Reimplemented in ShipEntity.

Definition at line 55 of file Entity.m.

                           :(ShipEntity *)sub
{
    OOLog(@"entity.bug", @"%s called for non-ship entity %p by %p", __PRETTY_FUNCTION__, self, sub);
}

◆ superShaderBindingTarget

- (id< OOWeakReferenceSupport >) superShaderBindingTarget

implementation

Definition at line 55 of file Entity.m.

{
    return [self parentEntity];
}

◆ systemEconomy

- (unsigned) systemEconomy

implementation

Provided by category Entity(ShaderBindings).

Definition at line 1 of file EntityShaderBindings.m.

{
    return [[PLAYER systemEconomy_number] unsignedIntValue];
}

◆ systemGovernment

- (unsigned) systemGovernment

implementation

Provided by category Entity(ShaderBindings).

Definition at line 1 of file EntityShaderBindings.m.

{
    return [[PLAYER systemGovernment_number] unsignedIntValue];
}

◆ systemPopulation

- (unsigned) systemPopulation

implementation

Provided by category Entity(ShaderBindings).

Definition at line 1 of file EntityShaderBindings.m.

{
    return [[PLAYER systemPopulation_number] unsignedIntValue];
}

◆ systemProductivity

- (unsigned) systemProductivity

implementation

Provided by category Entity(ShaderBindings).

Definition at line 1 of file EntityShaderBindings.m.

{
    return [[PLAYER systemProductivity_number] unsignedIntValue];
}

◆ systemTechLevel

- (unsigned) systemTechLevel

implementation

Provided by category Entity(ShaderBindings).

Definition at line 1 of file EntityShaderBindings.m.

{
    return [[PLAYER systemTechLevel_number] unsignedIntValue];
}

◆ takeEnergyDamage:from:becauseOf:weaponIdentifier:

- (void) takeEnergyDamage:	(double)	amount
from:	(Entity *)	ent
becauseOf:	(Entity *)	other
weaponIdentifier:	(NSString *)	weaponIdentifier

Reimplemented in DockEntity, PlayerEntity, ShipEntity, and StationEntity.

Definition at line 55 of file Entity.m.

                         :(double) amount from:(Entity *) ent becauseOf:(Entity *) other weaponIdentifier:(NSString *)weaponIdentifier
{
    
}

◆ throwingSparks

- (BOOL) throwingSparks

Definition at line 55 of file Entity.m.

{
    return throw_sparks;
}

◆ throwSparks

- (void) throwSparks

Reimplemented in ShipEntity.

Definition at line 55 of file Entity.m.

{
    // do nothing for now
}

◆ timeElapsedSinceSpawn

- (GLfloat) timeElapsedSinceSpawn

Definition at line 55 of file Entity.m.

{
    return [UNIVERSE getTime] - spawnTime;
}

◆ transformationMatrix

- (OOMatrix) transformationMatrix

Definition at line 55 of file Entity.m.

{
    OOMatrix result = rotMatrix;
    return OOMatrixHPTranslate(result, position);
}

◆ universalID

- (OOUniversalID) universalID

◆ universalTime

- (GLfloat) universalTime

Definition at line 55 of file Entity.m.

{
    return [UNIVERSE getTime];
}

◆ update:

- (void) update: (OOTimeDelta) delta_t

Reimplemented in OOBigFragmentBurstEntity, OOPlasmaBurstEntity, OOPlasmaShotEntity, DockEntity, DustEntity, OOBreakPatternEntity, OOECMBlastEntity, OOExhaustPlumeEntity, OOExplosionCloudEntity, OOFlashEffectEntity, OOFlasherEntity, OOLaserShotEntity, OOParticleSystem, OOSmallFragmentBurstEntity, OOPlanetEntity, OOQuiriumCascadeEntity, OORingEffectEntity, OOSparkEntity, OOSunEntity, OOVisualEffectEntity, PlayerEntity, ShipEntity, SkyEntity, StationEntity, and WormholeEntity.

Definition at line 55 of file Entity.m.

               :(OOTimeDelta)delta_t
{
    if (_status != STATUS_COCKPIT_DISPLAY)
    {
        if ([self isSubEntity])
        {
            zero_distance = [[self owner] zeroDistance];
            cam_zero_distance = [[self owner] camZeroDistance];
            [self updateCameraRelativePosition];
        }
        else
        {
            zero_distance = HPdistance2(PLAYER->position, position);
            cam_zero_distance = HPdistance2([PLAYER viewpointPosition], position);
            [self updateCameraRelativePosition];
        }
    }
    else
    {
        zero_distance = HPmagnitude2(position);
        cam_zero_distance = zero_distance;
        cameraRelativePosition = HPVectorToVector(position);
    }
    
    if ([self status] != STATUS_COCKPIT_DISPLAY)
    {
        [self applyVelocity:delta_t];
    }
 
    hasMoved = !HPvector_equal(position, lastPosition);
    hasRotated = !quaternion_equal(orientation, lastOrientation);
    lastPosition = position;
    lastOrientation = orientation;
}

◆ updateCameraRelativePosition

- (void) updateCameraRelativePosition

Reimplemented in DustEntity, and OOSunEntity.

Definition at line 55 of file Entity.m.

{
    cameraRelativePosition = HPVectorToVector(HPvector_subtract([self absolutePositionForSubentity],[PLAYER viewpointPosition]));
}

◆ updateLinkedLists

- (void) updateLinkedLists

Definition at line 55 of file Entity.m.

{
    if (!UNIVERSE)
        return; // not in the UNIVERSE - don't do this!
    if ((x_next == nil)&&(x_previous == nil))
        return; // not in the lists - don't do this!
    
#ifndef NDEBUG
    if (gDebugFlags & DEBUG_LINKED_LISTS)
    {
        if (![self checkLinkedLists])
        {
            OOLog(kOOLogEntityVerificationError, @"DEBUG LINKED LISTS problem encountered before updating linked lists for %@", self);
            [UNIVERSE debugDumpEntities];
        }
    }
#endif
    
    // update position in linked list for position.x
    // take self out of list..
    if (x_previous)     x_previous->x_next = x_next;
    if (x_next)         x_next->x_previous = x_previous;
    // sink DOWN the list
    while ((x_previous)&&(x_previous->position.x - x_previous->collision_radius > position.x - collision_radius))
    {
        x_next = x_previous;
        x_previous = x_previous->x_previous;
    }
    // bubble UP the list
    while ((x_next)&&(x_next->position.x - x_next->collision_radius < position.x - collision_radius))
    {
        x_previous = x_next;
        x_next = x_next->x_next;
    }
    if (x_next)     // insert self into the list before x_next..
        x_next->x_previous = self;
    if (x_previous) // insert self into the list after x_previous..
        x_previous->x_next = self;
    if ((x_previous == nil)&&(UNIVERSE))    // if we're the first then tell the UNIVERSE!
            UNIVERSE->x_list_start = self;
    
    // update position in linked list for position.y
    // take self out of list..
    if (y_previous)     y_previous->y_next = y_next;
    if (y_next)         y_next->y_previous = y_previous;
    // sink DOWN the list
    while ((y_previous)&&(y_previous->position.y - y_previous->collision_radius > position.y - collision_radius))
    {
        y_next = y_previous;
        y_previous = y_previous->y_previous;
    }
    // bubble UP the list
    while ((y_next)&&(y_next->position.y - y_next->collision_radius < position.y - collision_radius))
    {
        y_previous = y_next;
        y_next = y_next->y_next;
    }
    if (y_next)     // insert self into the list before y_next..
        y_next->y_previous = self;
    if (y_previous) // insert self into the list after y_previous..
        y_previous->y_next = self;
    if ((y_previous == nil)&&(UNIVERSE))    // if we're the first then tell the UNIVERSE!
            UNIVERSE->y_list_start = self;
    
    // update position in linked list for position.z
    // take self out of list..
    if (z_previous)     z_previous->z_next = z_next;
    if (z_next)         z_next->z_previous = z_previous;
    // sink DOWN the list
    while ((z_previous)&&(z_previous->position.z - z_previous->collision_radius > position.z - collision_radius))
    {
        z_next = z_previous;
        z_previous = z_previous->z_previous;
    }
    // bubble UP the list
    while ((z_next)&&(z_next->position.z - z_next->collision_radius < position.z - collision_radius))
    {
        z_previous = z_next;
        z_next = z_next->z_next;
    }
    if (z_next)     // insert self into the list before z_next..
        z_next->z_previous = self;
    if (z_previous) // insert self into the list after z_previous..
        z_previous->z_next = self;
    if ((z_previous == nil)&&(UNIVERSE))    // if we're the first then tell the UNIVERSE!
            UNIVERSE->z_list_start = self;
    
    // done
#ifndef NDEBUG
    if (gDebugFlags & DEBUG_LINKED_LISTS)
    {
        if (![self checkLinkedLists])
        {
            OOLog(kOOLogEntityUpdateError, @"DEBUG LINKED LISTS problem encountered after updating linked lists for %@", self);
            [UNIVERSE debugDumpEntities];
        }
    }
#endif
}

◆ validForAddToUniverse

- (BOOL) validForAddToUniverse

Reimplemented in PlayerEntity, and ShipEntity.

Definition at line 55 of file Entity.m.

{
    NSUInteger mySessionID = [self sessionID];
    NSUInteger currentSessionID = [UNIVERSE sessionID];
    if (EXPECT_NOT(mySessionID != currentSessionID))
    {
        OOLogERR(@"entity.invalidSession", @"Entity %@ from session %llu cannot be added to universe in session %llu. This is an internal error, please report it.", [self shortDescription], mySessionID, currentSessionID);
        return NO;
    }
    
    return YES;
}

◆ vectorTo:

- (Vector) vectorTo: (Entity *) entity

Definition at line 55 of file Entity.m.

                   :(Entity *)entity
{
    return HPVectorToVector(HPvector_subtract([entity position], [self position]));
}

◆ velocity

- (Vector) velocity

Reimplemented in ShipEntity.

◆ warnAboutHostiles

- (void) warnAboutHostiles

Reimplemented in PlayerEntity.

Definition at line 55 of file Entity.m.

{
    // do nothing for now, this can be expanded in sub classes
    OOLog(@"general.error.subclassResponsibility.Entity-warnAboutHostiles", @"%@", @"***** Entity does nothing in warnAboutHostiles");
}

◆ wasAddedToUniverse

- (void) wasAddedToUniverse

Reimplemented in ShipEntity.

Definition at line 55 of file Entity.m.

{
    // Do nothing
}

◆ wasRemovedFromUniverse

- (void) wasRemovedFromUniverse

Reimplemented in ShipEntity.

Definition at line 55 of file Entity.m.

{
    // Do nothing
}

◆ zeroDistance

- (double) zeroDistance

Definition at line 55 of file Entity.m.

{
    return zero_distance;
}

Member Data Documentation

◆ _jsSelf

- (struct JSObject*) _jsSelf

protected

Definition at line 152 of file Entity.h.

◆ _owner

- (OOWeakReference*) _owner

private

Definition at line 158 of file Entity.h.

◆ _sessionID

- (NSUInteger) _sessionID

private

Definition at line 156 of file Entity.h.

◆ _status

- (OOEntityStatus) _status

private

Definition at line 159 of file Entity.h.

◆ atmosphereFogging

- (OOColor*) atmosphereFogging

Definition at line 115 of file Entity.h.

◆ boundingBox

- (BoundingBox) boundingBox

protected

Definition at line 145 of file Entity.h.

Referenced by OOLaserShotEntity::dealloc, and ShipGetProperty().

◆ cam_zero_distance

- (GLfloat) cam_zero_distance

Definition at line 109 of file Entity.h.

◆ cameraRelativePosition

- (Vector) cameraRelativePosition

Definition at line 113 of file Entity.h.

◆ collider

- (Entity*) collider

Definition at line 128 of file Entity.h.

◆ collidingEntities

- (NSMutableArray*) collidingEntities

protected

Definition at line 148 of file Entity.h.

◆ collision_chain

- (Entity*) collision_chain

Definition at line 124 of file Entity.h.

◆ collision_radius

- (GLfloat) collision_radius

Definition at line 111 of file Entity.h.

Referenced by Universe::addCommsMessage:forCount:, CollisionRegion::entityByEntityOcclusionToValue, HeadUpDisplay::hudDrawReticleOnTarget, and CollisionRegion::shadowAtPointOcclusionToValue.

◆ collisionRegion

- (CollisionRegion *) collisionRegion

Definition at line 130 of file Entity.h.

◆ collisionTestFilter

- (unsigned) collisionTestFilter

Definition at line 100 of file Entity.h.

◆ distanceTravelled

- (GLfloat) distanceTravelled

protected

Definition at line 136 of file Entity.h.

◆ energy

- (GLfloat) energy

protected

Definition at line 142 of file Entity.h.

◆ hasCollided

- (unsigned) hasCollided

Definition at line 98 of file Entity.h.

◆ hasMoved

- (unsigned) hasMoved

Definition at line 96 of file Entity.h.

◆ hasRotated

- (unsigned) hasRotated

Definition at line 97 of file Entity.h.

◆ isExplicitlyNotMainStation

- (unsigned) isExplicitlyNotMainStation

Definition at line 103 of file Entity.h.

Referenced by Universe::IsCandidateMainStationPredicate.

◆ isImmuneToBreakPatternHide

- (BOOL) isImmuneToBreakPatternHide

Definition at line 102 of file Entity.h.

◆ isPlayer

- (BOOL) isPlayer

Definition at line 93 of file Entity.h.

◆ isShip

- (BOOL) isShip

Definition at line 91 of file Entity.h.

Referenced by OOLaserShotEntity::dealloc, and IsShipPredicate().

◆ isStation

- (BOOL) isStation

Definition at line 92 of file Entity.h.

Referenced by Universe::breakPatternHide, Universe::IsCandidateMainStationPredicate, and IsStationPredicate().

◆ isSubEntity

- (BOOL) isSubEntity

Definition at line 95 of file Entity.h.

Referenced by IsShipPredicate(), and IsVisualEffectPredicate().

◆ isSunlit

- (BOOL) isSunlit

Definition at line 99 of file Entity.h.

◆ isVisualEffect

- (BOOL) isVisualEffect

Definition at line 104 of file Entity.h.

Referenced by IsVisualEffectPredicate().

◆ isWormhole

- (BOOL) isWormhole

Definition at line 94 of file Entity.h.

◆ lastDrawCounter

- (NSUInteger) lastDrawCounter

protected

Definition at line 153 of file Entity.h.

◆ lastOrientation

- (Quaternion) lastOrientation

protected

Definition at line 134 of file Entity.h.

◆ lastPosition

- (HPVector) lastPosition

protected

Definition at line 133 of file Entity.h.

◆ mass

- (GLfloat) mass

protected

Definition at line 146 of file Entity.h.

◆ maxEnergy

- (GLfloat) maxEnergy

protected

Definition at line 143 of file Entity.h.

Referenced by OOShipLibraryShields().

◆ no_draw_distance

- (GLfloat) no_draw_distance

Definition at line 110 of file Entity.h.

◆ orientation

- (Quaternion) orientation

Definition at line 114 of file Entity.h.

Referenced by HeadUpDisplay::hudRotateViewpointForVirtualDepth, JSObjectGetQuaternion(), and WaypointGetProperty().

◆ position

- (HPVector) position

Definition at line 112 of file Entity.h.

Referenced by Universe::addCommsMessage:forCount:, OOLaserShotEntity::dealloc, CollisionRegion::entityByEntityOcclusionToValue, JSObjectGetVector(), and CollisionRegion::shadowAtPointOcclusionToValue.

◆ rotMatrix

- (OOMatrix) rotMatrix

protected

Definition at line 138 of file Entity.h.

◆ scanClass

- (OOScanClass) scanClass

Definition at line 106 of file Entity.h.

Referenced by HasScanClassPredicate().

◆ shadingEntityID

- (OOUniversalID) shadingEntityID

Definition at line 126 of file Entity.h.

◆ spawnTime

- (GLfloat) spawnTime

protected

Definition at line 150 of file Entity.h.

◆ throw_sparks

- (unsigned) throw_sparks

Definition at line 101 of file Entity.h.

◆ universalID

- (OOUniversalID) universalID

Definition at line 89 of file Entity.h.

◆ velocity

- (Vector) velocity

protected

Definition at line 140 of file Entity.h.

Referenced by OOLaserShotEntity::dealloc.

◆ x_next

- (Entity *) x_next

Definition at line 120 of file Entity.h.

Referenced by Universe::addEntity:.

◆ x_previous

- (Entity*) x_previous

Definition at line 120 of file Entity.h.

Referenced by Universe::addEntity:.

◆ y_next

- (Entity *) y_next

Definition at line 121 of file Entity.h.

Referenced by Universe::addEntity:.

◆ y_previous

- (Entity*) y_previous

Definition at line 121 of file Entity.h.

Referenced by Universe::addEntity:.

◆ z_next

- (Entity *) z_next

Definition at line 122 of file Entity.h.

Referenced by Universe::addEntity:.

◆ z_previous

- (Entity*) z_previous

Definition at line 122 of file Entity.h.

Referenced by Universe::addEntity:.

◆ zero_distance

- (GLfloat) zero_distance

Definition at line 108 of file Entity.h.

Referenced by HeadUpDisplay::hudDrawReticleOnTarget.

◆ zero_index

- (int) zero_index

Definition at line 117 of file Entity.h.

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

src/Core/Entities/Entity.h
src/Core/Entities/Entity.m

Instance Methods

Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Method Documentation

◆ absolutePositionForSubentity

◆ absolutePositionForSubentityOffset:

◆ addToLinkedLists

◆ allTextures

◆ applyRoll:andClimb:

◆ applyRoll:climb:andYaw:

◆ applyVelocity:

◆ boundingBox

◆ cameraRangeBack

◆ cameraRangeFront

◆ cameraRelativePosition

◆ camZeroDistance

◆ canCollide

◆ checkCloseCollisionWith:

◆ checkLinkedLists

◆ clock

◆ collisionArray

◆ collisionRadius

◆ collisionRegion

◆ compareZeroDistance:

◆ dealloc

◆ deleteJSSelf

◆ descriptionComponents

◆ descriptionForObjDump

◆ descriptionForObjDumpBasic

◆ distanceTravelled

◆ drawImmediate:translucent:

◆ drawRotationMatrix

◆ drawSubEntityImmediate:translucent:

◆ drawTransformationMatrix

◆ dumpSelfState

◆ dumpState

◆ energy

◆ findCollisionRadius

◆ fogUniform

◆ frustumRadius

◆ getJSClass:andPrototype:

◆ init

◆ inspect

◆ isBreakPattern

◆ isCascadeWeapon

◆ isDock

◆ isECMBlast

◆ isEffect

◆ isExhaust

◆ isFlasher

◆ isImmuneToBreakPatternHide

◆ isInSpace

◆ isPlanet

◆ isPlayer

◆ isPlayerLikeShip

◆ isShip

◆ isShipWithSubEntityShip:

◆ isSky

◆ isStation

◆ isStellarObject

◆ isSubEntity

◆ isSun

◆ isSunlit

◆ isVisible

◆ isVisibleToScripts

◆ isVisualEffect

◆ isWaypoint

◆ isWormhole

◆ lastDrawCounter

◆ mass

◆ maxEnergy

◆ moveForward:

◆ normalOrientation

◆ oo_jsClassName

◆ oo_jsValueInContext:

◆ orientation

◆ orientationChanged

◆ owner