#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

(NSUInteger)	- lastDrawCounter

(void)	- setLastDrawCounter:

(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

(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

NSUInteger	lastDrawCounter

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

{
    return _beaconCode;
}

Referenced by WaypointGetProperty().

Here is the caller graph for this function:

◆ beaconDrawable

- (id< OOHUDBeaconIcon >) beaconDrawable

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 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;
}

◆ beaconLabel

- (NSString *) beaconLabel

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 of file OOWaypointEntity.m.

{
    return _beaconLabel;
}

Referenced by WaypointGetProperty().

Here is the caller graph for this function:

◆ compareBeaconCodeWith:

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

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 of file OOWaypointEntity.m.

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

◆ dealloc

- (void) dealloc

implementation

Reimplemented from Entity.

Definition at line 1 of file OOWaypointEntity.m.

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

◆ drawImmediate:translucent:

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

implementation

Reimplemented from Entity.

Definition at line 1 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();
}

◆ getJSClass:andPrototype:

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

Reimplemented from Entity.

Provided by category OOWaypointEntity(OOJavaScriptExtensions).

Definition at line 187 of file OOJSWaypoint.m.

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

◆ initWithDictionary:

- (id) initWithDictionary: (NSDictionary *) info

Definition at line 1 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;
}

◆ isBeacon

- (BOOL) isBeacon

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 of file OOWaypointEntity.m.

{
    return [self beaconCode] != nil;
}

◆ isEffect

- (BOOL) isEffect

implementation

Reimplemented from Entity.

Definition at line 1 of file OOWaypointEntity.m.

{
    return YES;
}

◆ isJammingScanning

- (BOOL) isJammingScanning

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 of file OOWaypointEntity.m.

{
    return NO;
}

◆ isVisibleToScripts

- (BOOL) isVisibleToScripts

Reimplemented from Entity.

Provided by category OOWaypointEntity(OOJavaScriptExtensions).

Definition at line 187 of file OOJSWaypoint.m.

{
    return YES;
}

◆ isWaypoint

- (BOOL) isWaypoint

implementation

Reimplemented from Entity.

Definition at line 1 of file OOWaypointEntity.m.

{
    return YES;
}

◆ nextBeacon

- (Entity< OOBeaconEntity > *) nextBeacon

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 of file OOWaypointEntity.m.

{
    return [_nextBeacon weakRefUnderlyingObject];
}

◆ oo_jsClassName

- (NSString *) oo_jsClassName

Reimplemented from Entity.

Provided by category OOWaypointEntity(OOJavaScriptExtensions).

Definition at line 187 of file OOJSWaypoint.m.

{
    return @"Waypoint";
}

◆ oriented

- (BOOL) oriented

◆ prevBeacon

- (Entity< OOBeaconEntity > *) prevBeacon

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 of file OOWaypointEntity.m.

{
    return [_prevBeacon weakRefUnderlyingObject];
}

◆ setBeaconCode:

- (void) setBeaconCode: (NSString *) bcode

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 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];
    }
 
}

Referenced by OOWaypointEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:.

Here is the caller graph for this function:

◆ setBeaconLabel:

- (void) setBeaconLabel: (NSString *) blabel

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 of file OOWaypointEntity.m.

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

Referenced by OOWaypointEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:.

Here is the caller graph for this function:

◆ setNextBeacon:

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

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 of file OOWaypointEntity.m.

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

◆ setOrientation:

- (void) setOrientation: (Quaternion) q

implementation

Reimplemented from Entity.

Definition at line 1 of file OOWaypointEntity.m.

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

◆ setPrevBeacon:

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

implementation

Reimplemented from <OOBeaconEntity>.

Definition at line 1 of file OOWaypointEntity.m.

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

◆ setSize:

- (void) setSize: (OOScalar) newSize

Definition at line 1 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;
    }
}

Referenced by OOWaypointEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:.

Here is the caller graph for this function:

◆ size

- (OOScalar) size

Definition at line 1 of file OOWaypointEntity.m.

{
    return _size;
}

◆ waypointWithDictionary:

+ (instancetype) waypointWithDictionary: (NSDictionary *) info

Definition at line 1 of file OOWaypointEntity.m.

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

Member Data Documentation

◆ _beaconCode

- (NSString*) _beaconCode

private

Definition at line 36 of file OOWaypointEntity.h.

◆ _beaconDrawable

- (id<OOHUDBeaconIcon>) _beaconDrawable

private

Definition at line 40 of file OOWaypointEntity.h.

◆ _beaconLabel

- (NSString*) _beaconLabel

private

Definition at line 37 of file OOWaypointEntity.h.

◆ _nextBeacon

- (OOWeakReference*) _nextBeacon

private

Definition at line 39 of file OOWaypointEntity.h.

◆ _prevBeacon

- (OOWeakReference*) _prevBeacon

private

Definition at line 38 of file OOWaypointEntity.h.

◆ _size

- (OOScalar) _size

private

Definition at line 34 of file OOWaypointEntity.h.

◆ oriented

- (BOOL) oriented

private

Definition at line 41 of file OOWaypointEntity.h.

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

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

Instance Methods

Class Methods

Private Attributes

Additional Inherited Members

Detailed Description

Method Documentation

◆ beaconCode

◆ beaconDrawable

◆ beaconLabel

◆ compareBeaconCodeWith:

◆ dealloc

◆ drawImmediate:translucent:

◆ getJSClass:andPrototype:

◆ initWithDictionary:

◆ isBeacon

◆ isEffect

◆ isJammingScanning

◆ isVisibleToScripts

◆ isWaypoint

◆ nextBeacon

◆ oo_jsClassName

◆ oriented

◆ prevBeacon

◆ setBeaconCode:

◆ setBeaconLabel:

◆ setNextBeacon:

◆ setOrientation:

◆ setPrevBeacon:

◆ setSize:

◆ size

◆ waypointWithDictionary:

Member Data Documentation

◆ _beaconCode

◆ _beaconDrawable

◆ _beaconLabel

◆ _nextBeacon

◆ _prevBeacon

◆ _size

◆ oriented