OOWaypointEntity Class Reference

#include <OOWaypointEntity.h>

Inheritance diagram for OOWaypointEntity:

Collaboration diagram for OOWaypointEntity:

Instance Methods
(id)	- initWithDictionary:
(BOOL)	- oriented
(OOScalar)	- size
(void)	- setSize:
(void)	- dealloc [implementation]
(void)	- setOrientation: [implementation]
(BOOL)	- isEffect [implementation]
(BOOL)	- isWaypoint [implementation]
(void)	- drawImmediate:translucent: [implementation]
(NSComparisonResult)	- compareBeaconCodeWith: [implementation]
(NSString *)	- beaconCode [implementation]
(void)	- setBeaconCode: [implementation]
(NSString *)	- beaconLabel [implementation]
(void)	- setBeaconLabel: [implementation]
(BOOL)	- isBeacon [implementation]
(id< OOHUDBeaconIcon >)	- beaconDrawable [implementation]
(Entity< OOBeaconEntity > *)	- prevBeacon [implementation]
(Entity< OOBeaconEntity > *)	- nextBeacon [implementation]
(void)	- setPrevBeacon: [implementation]
(void)	- setNextBeacon: [implementation]
(BOOL)	- isJammingScanning [implementation]
(void)	- getJSClass:andPrototype:
(NSString *)	- oo_jsClassName
(BOOL)	- isVisibleToScripts
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)	- 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
(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
(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]
(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
(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)	+ waypointWithDictionary:

Private Attributes
OOScalar	_size
NSString *	_beaconCode
NSString *	_beaconLabel
OOWeakReference *	_prevBeacon
OOWeakReference *	_nextBeacon
id< OOHUDBeaconIcon >	_beaconDrawable
BOOL	oriented

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 30 of file OOWaypointEntity.h.

Method Documentation

beaconCode

- (NSString *) beaconCode

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 206 of file OOWaypointEntity.m.

{
    return _beaconCode;
}

References _beaconCode, and beaconCode.

Referenced by beaconCode, beaconDrawable, compareBeaconCodeWith:, isBeacon, and WaypointGetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

beaconDrawable

- (id< OOHUDBeaconIcon >) beaconDrawable

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 256 of file OOWaypointEntity.m.

{
    if (_beaconDrawable == nil)
    {
        NSString    *beaconCode = [self beaconCode];
        NSUInteger  length = [beaconCode length];
        
        if (length > 1)
        {
            NSArray *iconData = [[UNIVERSE descriptions] oo_arrayForKey:beaconCode];
            if (iconData != nil)  _beaconDrawable = [[OOPolygonSprite alloc] initWithDataArray:iconData outlineWidth:0.5 name:beaconCode];
        }
        
        if (_beaconDrawable == nil)
        {
            if (length > 0)  _beaconDrawable = [[beaconCode substringToIndex:1] retain];
            else  _beaconDrawable = @"";
        }
    }
    
    return _beaconDrawable;
}

References _beaconDrawable, beaconCode, beaconDrawable, and nil.

Referenced by beaconDrawable.

Here is the call graph for this function:

Here is the caller graph for this function:

beaconLabel

- (NSString *) beaconLabel

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 232 of file OOWaypointEntity.m.

{
    return _beaconLabel;
}

References _beaconLabel, and beaconLabel.

Referenced by beaconLabel, and WaypointGetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

compareBeaconCodeWith:

- (NSComparisonResult) compareBeaconCodeWith: (Entity<OOBeaconEntity> *) other

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 200 of file OOWaypointEntity.m.

                                            :(Entity<OOBeaconEntity> *) other
{
    return [[self beaconCode] compare:[other beaconCode] options: NSCaseInsensitiveSearch];
}

References beaconCode.

Here is the call graph for this function:

dealloc

- (void) dealloc

implementation

Reimplemented from Entity.

Definition at line 68 of file OOWaypointEntity.m.

{
    DESTROY(_beaconCode);
    DESTROY(_beaconLabel);
    DESTROY(_prevBeacon);
    DESTROY(_nextBeacon);
    DESTROY(_beaconDrawable);
 
    [super dealloc];
}

References _beaconCode, _beaconDrawable, _beaconLabel, _nextBeacon, _prevBeacon, Entity::dealloc, dealloc, and DESTROY.

Referenced by dealloc.

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

                      :(bool)immediate translucent:(bool)translucent
{
    if (!translucent || no_draw_distance < cam_zero_distance)
    {
        return;
    }
 
    if (![PLAYER hasEquipmentItemProviding:@"EQ_ADVANCED_COMPASS"])
    {
        return;
    }
 
    int8_t i,j,k;
 
    GLfloat a = 0.75;
    if ([PLAYER compassTarget] != self)
    {
        a *= 0.25;
    }
    if (cam_zero_distance > _size * _size)
    {
        // dim out as gets further away; 2-D HUD display more
        // important at long range
        a -=  0.004f*(sqrtf(cam_zero_distance) / _size);
    }
    if (a < 0.01f)
    {
        return;
    }
 
    GLfloat s0 = _size;
    GLfloat s1 = _size * 0.75f;
 
    OO_ENTER_OPENGL();
    OOSetOpenGLState(OPENGL_STATE_TRANSLUCENT_PASS);
    OOGL(glEnable(GL_BLEND));
    GLScaledLineWidth(1.0);
 
    OOGL(glColor4f(0.0, 0.0, 1.0, a));
    OOGLBEGIN(GL_LINES);
    for (i = -1; i <= 1; i+=2)
    {
        for (j = -1; j <= 1; j+=2)
        {
            for (k = -1; k <= 1; k+=2)
            {
                glVertex3f(i*s0,j*s0,k*s1); glVertex3f(i*s0,j*s1,k*s0);
                glVertex3f(i*s0,j*s1,k*s0); glVertex3f(i*s1,j*s0,k*s0);
                glVertex3f(i*s1,j*s0,k*s0); glVertex3f(i*s0,j*s0,k*s1);
            }
        }
    }
    if (oriented)
    {
        while (s1 > 20.0f)
        {
            glVertex3f(-20.0,0,-s1-20.0f);  glVertex3f(0,0,-s1);
            glVertex3f(20.0,0,-s1-20.0f);   glVertex3f(0,0,-s1);
            glVertex3f(-20.0,0,s1-20.0f);   glVertex3f(0,0,s1);
            glVertex3f(20.0,0,s1-20.0f);    glVertex3f(0,0,s1);
            s1 *= 0.5;
        }
    }
    OOGLEND();
 
    OOGL(glDisable(GL_BLEND));
    OOVerifyOpenGLState();
}

References _size, Entity::cam_zero_distance, GLScaledLineWidth(), Entity::no_draw_distance, OO_ENTER_OPENGL, OOGL, OOGLBEGIN, OOGLEND, OOSetOpenGLState, OOVerifyOpenGLState, OPENGL_STATE_TRANSLUCENT_PASS, oriented, and PLAYER.

Here is the call graph for this function:

getJSClass:andPrototype:

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

Reimplemented from Entity.

Provided by category OOWaypointEntity(OOJavaScriptExtensions).

Definition at line 121 of file OOJSWaypoint.m.

                  :(JSClass **)outClass andPrototype:(JSObject **)outPrototype
{
    *outClass = &sWaypointClass;
    *outPrototype = sWaypointPrototype;
}

initWithDictionary:

- (id) initWithDictionary:

(NSDictionary *)

info

Definition at line 48 of file OOWaypointEntity.m.

                         :(NSDictionary *)info
{
    self = [super init];
    if (EXPECT_NOT(self == nil))  return nil;
 
    oriented = YES;
    position = [info oo_hpvectorForKey:OOWAYPOINT_KEY_POSITION];
    Quaternion q = [info oo_quaternionForKey:OOWAYPOINT_KEY_ORIENTATION];
    [self setOrientation:q];
    [self setSize:[info oo_nonNegativeFloatForKey:OOWAYPOINT_KEY_SIZE defaultValue:1000.0]];
    [self setBeaconCode:[info oo_stringForKey:OOWAYPOINT_KEY_CODE defaultValue:@"W"]];
    [self setBeaconLabel:[info oo_stringForKey:OOWAYPOINT_KEY_LABEL defaultValue:@"Waypoint"]];
    
    [self setStatus:STATUS_EFFECT];
    [self setScanClass:CLASS_NO_DRAW];
 
    return self;
}

References EXPECT_NOT, Entity::init, nil, oriented, Entity::position, setBeaconCode:, setBeaconLabel:, setOrientation:, Entity::setScanClass:, setSize:, and Entity::setStatus:.

Here is the call graph for this function:

isBeacon

- (BOOL) isBeacon

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 250 of file OOWaypointEntity.m.

{
    return [self beaconCode] != nil;
}

References beaconCode, isBeacon, and nil.

Referenced by isBeacon.

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 116 of file OOWaypointEntity.m.

{
    return YES;
}

References isEffect.

Referenced by isEffect.

Here is the call graph for this function:

Here is the caller graph for this function:

isJammingScanning

- (BOOL) isJammingScanning

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 312 of file OOWaypointEntity.m.

{
    return NO;
}

References isJammingScanning.

Referenced by isJammingScanning.

Here is the call graph for this function:

Here is the caller graph for this function:

isVisibleToScripts

- (BOOL) isVisibleToScripts

Reimplemented from Entity.

Provided by category OOWaypointEntity(OOJavaScriptExtensions).

Definition at line 133 of file OOJSWaypoint.m.

{
    return YES;
}

isWaypoint

- (BOOL) isWaypoint

implementation

Reimplemented from Entity.

Definition at line 122 of file OOWaypointEntity.m.

{
    return YES;
}

References isWaypoint.

Referenced by isWaypoint.

Here is the call graph for this function:

Here is the caller graph for this function:

nextBeacon

- (Entity< OOBeaconEntity > *) nextBeacon

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 286 of file OOWaypointEntity.m.

{
    return [_nextBeacon weakRefUnderlyingObject];
}

References nextBeacon, and OOWeakReference::weakRefUnderlyingObject.

Referenced by nextBeacon, and setNextBeacon:.

Here is the call graph for this function:

Here is the caller graph for this function:

oo_jsClassName

- (NSString *) oo_jsClassName

Reimplemented from Entity.

Provided by category OOWaypointEntity(OOJavaScriptExtensions).

Definition at line 128 of file OOJSWaypoint.m.

{
    return @"Waypoint";
}

oriented

- (BOOL) oriented

References size.

Here is the call graph for this function:

prevBeacon

- (Entity< OOBeaconEntity > *) prevBeacon

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 280 of file OOWaypointEntity.m.

{
    return [_prevBeacon weakRefUnderlyingObject];
}

References prevBeacon, and OOWeakReference::weakRefUnderlyingObject.

Referenced by prevBeacon, and setPrevBeacon:.

Here is the call graph for this function:

Here is the caller graph for this function:

setBeaconCode:

- (void) setBeaconCode: (NSString *) bcode

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 212 of file OOWaypointEntity.m.

                      :(NSString *)bcode
{
    if ([bcode length] == 0)  bcode = nil;
    
    if (_beaconCode != bcode)
    {
        [_beaconCode release];
        _beaconCode = [bcode copy];
        
        DESTROY(_beaconDrawable);
    }
    // if not blanking code and label is currently blank, default label to code
    if (bcode != nil && (_beaconLabel == nil || [_beaconLabel length] == 0))
    {
        [self setBeaconLabel:bcode];
    }
 
}

References _beaconCode, _beaconDrawable, _beaconLabel, DESTROY, nil, and setBeaconLabel:.

Referenced by initWithDictionary:, and WaypointSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

setBeaconLabel:

- (void) setBeaconLabel: (NSString *) blabel

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 238 of file OOWaypointEntity.m.

                       :(NSString *)blabel
{
    if ([blabel length] == 0)  blabel = nil;
    
    if (_beaconLabel != blabel)
    {
        [_beaconLabel release];
        _beaconLabel = [OOExpand(blabel) retain];
    }
}

References _beaconLabel, and nil.

Referenced by initWithDictionary:, setBeaconCode:, and WaypointSetProperty().

Here is the caller graph for this function:

setNextBeacon:

- (void) setNextBeacon: (Entity <OOBeaconEntity> *) beaconShip

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 302 of file OOWaypointEntity.m.

                      :(Entity <OOBeaconEntity> *)beaconShip
{
    if (beaconShip != [self nextBeacon])
    {
        [_nextBeacon release];
        _nextBeacon = [beaconShip weakRetain];
    }
}

References _nextBeacon, and nextBeacon.

Here is the call graph for this function:

setOrientation:

- (void) setOrientation: (Quaternion) q

implementation

Reimplemented from Entity.

Definition at line 81 of file OOWaypointEntity.m.

                       :(Quaternion)q
{
    if (quaternion_equal(q,kZeroQuaternion)) {
        q = kIdentityQuaternion;
        oriented = NO;
    } else {
        oriented = YES;
    }
    [super setOrientation:q];
}

References kIdentityQuaternion, kZeroQuaternion, oriented, and Entity::setOrientation:.

Referenced by initWithDictionary:.

Here is the call graph for this function:

Here is the caller graph for this function:

setPrevBeacon:

- (void) setPrevBeacon: (Entity <OOBeaconEntity> *) beaconShip

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 292 of file OOWaypointEntity.m.

                      :(Entity <OOBeaconEntity> *)beaconShip
{
    if (beaconShip != [self prevBeacon])
    {
        [_prevBeacon release];
        _prevBeacon = [beaconShip weakRetain];
    }
}

References _prevBeacon, and prevBeacon.

Here is the call graph for this function:

setSize:

- (void) setSize:

(OOScalar)

newSize

Definition at line 105 of file OOWaypointEntity.m.

                :(OOScalar)newSize
{
    if (newSize > 0)
    {
        _size = newSize;
        no_draw_distance = newSize * newSize * NO_DRAW_DISTANCE_FACTOR * NO_DRAW_DISTANCE_FACTOR * 2;
    }
}

References _size, Entity::no_draw_distance, and NO_DRAW_DISTANCE_FACTOR.

Referenced by initWithDictionary:, and WaypointSetProperty().

Here is the caller graph for this function:

size

- (OOScalar) size

Definition at line 99 of file OOWaypointEntity.m.

{
    return _size;
}

References _size, and size.

Referenced by oriented, and size.

Here is the call graph for this function:

Here is the caller graph for this function:

waypointWithDictionary:

+ (instancetype) waypointWithDictionary:

(NSDictionary *)

info

Definition at line 43 of file OOWaypointEntity.m.

                                       :(NSDictionary *)info
{
    return [[[OOWaypointEntity alloc] initWithDictionary:info] autorelease];
}

Referenced by Universe::defineWaypoint:forKey:.

Here is the caller graph for this function:

Member Data Documentation

_beaconCode

- (NSString*) _beaconCode

private

Definition at line 36 of file OOWaypointEntity.h.

Referenced by beaconCode, dealloc, and setBeaconCode:.

_beaconDrawable

- (id<OOHUDBeaconIcon>) _beaconDrawable

private

Definition at line 40 of file OOWaypointEntity.h.

Referenced by beaconDrawable, dealloc, and setBeaconCode:.

_beaconLabel

- (NSString*) _beaconLabel

private

Definition at line 37 of file OOWaypointEntity.h.

Referenced by beaconLabel, dealloc, setBeaconCode:, and setBeaconLabel:.

_nextBeacon

- (OOWeakReference*) _nextBeacon

private

Definition at line 39 of file OOWaypointEntity.h.

Referenced by dealloc, and setNextBeacon:.

_prevBeacon

- (OOWeakReference*) _prevBeacon

private

Definition at line 38 of file OOWaypointEntity.h.

Referenced by dealloc, and setPrevBeacon:.

_size

- (OOScalar) _size

private

Definition at line 34 of file OOWaypointEntity.h.

Referenced by drawImmediate:translucent:, setSize:, and size.

oriented

- (BOOL) oriented

private

Definition at line 93 of file OOWaypointEntity.m.

{
    return oriented;
}

Referenced by drawImmediate:translucent:, initWithDictionary:, and setOrientation:.

---

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

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