SkyEntity Class Reference

#include <SkyEntity.h>

Inheritance diagram for SkyEntity:

Collaboration diagram for SkyEntity:

Instance Methods
(id)	- initWithColors:col1:andSystemInfo:
(BOOL)	- changeProperty:withDictionary:
(OOColor *)	- skyColor
(void)	- dealloc [implementation]
(void)	- update: [implementation]
(BOOL)	- isSky [implementation]
(BOOL)	- isVisible [implementation]
(BOOL)	- canCollide [implementation]
(GLfloat)	- cameraRangeFront [implementation]
(GLfloat)	- cameraRangeBack [implementation]
(void)	- drawImmediate:translucent: [implementation]
(NSString *)	- descriptionForObjDump [implementation]
(BOOL)	- readColor1:andColor2:andColor3:andColor4:fromDictionary: [implementation]
Instance Methods inherited from OOEntityWithDrawable
(OODrawable *)	- drawable
(void)	- setDrawable:
(double)	- findCollisionRadius [implementation]
(NSSet *)	- allTextures [implementation]
Instance Methods inherited from Entity
(NSUInteger)	- sessionID
(BOOL)	- isShip
(BOOL)	- isDock
(BOOL)	- isStation
(BOOL)	- isSubEntity
(BOOL)	- isPlayer
(BOOL)	- isPlanet
(BOOL)	- isSun
(BOOL)	- isSunlit
(BOOL)	- isStellarObject
(BOOL)	- 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
(void)	- updateCameraRelativePosition
(Vector)	- vectorTo:
(HPVector)	- absolutePositionForSubentity
(HPVector)	- absolutePositionForSubentityOffset:
(double)	- zeroDistance
(double)	- camZeroDistance
(NSComparisonResult)	- compareZeroDistance:
(BoundingBox)	- boundingBox
(GLfloat)	- mass
(Quaternion)	- orientation
(void)	- setOrientation:
(Quaternion)	- normalOrientation
(void)	- setNormalOrientation:
(void)	- orientationChanged
(void)	- setVelocity:
(Vector)	- velocity
(double)	- speed
(GLfloat)	- distanceTravelled
(void)	- setDistanceTravelled:
(void)	- setStatus:
(OOEntityStatus)	- status
(void)	- setScanClass:
(OOScanClass)	- scanClass
(void)	- setEnergy:
(GLfloat)	- energy
(void)	- setMaxEnergy:
(GLfloat)	- maxEnergy
(void)	- applyRoll:andClimb:
(void)	- applyRoll:climb:andYaw:
(void)	- moveForward:
(OOMatrix)	- rotationMatrix
(OOMatrix)	- drawRotationMatrix
(OOMatrix)	- transformationMatrix
(OOMatrix)	- drawTransformationMatrix
(GLfloat)	- collisionRadius
(GLfloat)	- frustumRadius
(void)	- setCollisionRadius:
(NSMutableArray *)	- collisionArray
(void)	- applyVelocity:
(BOOL)	- checkCloseCollisionWith:
(void)	- takeEnergyDamage:from:becauseOf:weaponIdentifier:
(void)	- dumpState
(void)	- dumpSelfState
(BOOL)	- isInSpace
(BOOL)	- isImmuneToBreakPatternHide
(GLfloat)	- universalTime
(GLfloat)	- spawnTime
(GLfloat)	- timeElapsedSinceSpawn
(void)	- setAtmosphereFogging:
(OOColor *)	- fogUniform
(NSString *)	- descriptionForObjDumpBasic
(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
(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

Protected Attributes
OOColor *	skyColor
Protected Attributes inherited from Entity
HPVector	lastPosition
Quaternion	lastOrientation
GLfloat	distanceTravelled
OOMatrix	rotMatrix
Vector	velocity
GLfloat	energy
GLfloat	maxEnergy
BoundingBox	boundingBox
GLfloat	mass
NSMutableArray *	collidingEntities
OOTimeAbsolute	spawnTime
struct JSObject *	_jsSelf
Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Additional Inherited Members
Public Attributes inherited from Entity
OOUniversalID	universalID
unsigned	isShip: 1
unsigned	isStation: 1
unsigned	isPlayer: 1
unsigned	isWormhole: 1
unsigned	isSubEntity: 1
unsigned	hasMoved: 1
unsigned	hasRotated: 1
unsigned	hasCollided: 1
unsigned	isSunlit: 1
unsigned	collisionTestFilter: 2
unsigned	throw_sparks: 1
unsigned	isImmuneToBreakPatternHide: 1
unsigned	isExplicitlyNotMainStation: 1
unsigned	isVisualEffect: 1
OOScanClass	scanClass
GLfloat	zero_distance
GLfloat	cam_zero_distance
GLfloat	no_draw_distance
GLfloat	collision_radius
HPVector	position
Vector	cameraRelativePosition
Quaternion	orientation
OOColor *	atmosphereFogging
int	zero_index
Entity *	x_previous
Entity *	x_next
Entity *	y_previous
Entity *	y_next
Entity *	z_previous
Entity *	z_next
Entity *	collision_chain
OOUniversalID	shadingEntityID
Entity *	collider
CollisionRegion *	collisionRegion

Detailed Description

Definition at line 32 of file SkyEntity.h.

Method Documentation

cameraRangeBack

- (GLfloat) cameraRangeBack

implementation

Reimplemented from Entity.

Definition at line 229 of file SkyEntity.m.

{
    return MAX_CLEAR_DEPTH;
}

References cameraRangeBack, and MAX_CLEAR_DEPTH.

Referenced by cameraRangeBack.

Here is the call graph for this function:

Here is the caller graph for this function:

cameraRangeFront

- (GLfloat) cameraRangeFront

implementation

Reimplemented from Entity.

Definition at line 223 of file SkyEntity.m.

{
    return MAX_CLEAR_DEPTH;
}

References cameraRangeFront, and MAX_CLEAR_DEPTH.

Referenced by cameraRangeFront.

Here is the call graph for this function:

Here is the caller graph for this function:

canCollide

- (BOOL) canCollide

implementation

Reimplemented from Entity.

Definition at line 217 of file SkyEntity.m.

{
    return NO;
}

References canCollide.

Referenced by canCollide.

Here is the call graph for this function:

Here is the caller graph for this function:

changeProperty:withDictionary:

- (BOOL) changeProperty:		(NSString *)	key
withDictionary:		(NSDictionary*)	dict

Definition at line 164 of file SkyEntity.m.

                       :(NSString *)key withDictionary:(NSDictionary*)dict
{
    id  object = [dict objectForKey:key];
    
    // TODO: properties requiring reInit?
    if ([key isEqualToString:@"sun_color"])
    {
        OOColor     *col=[[OOColor colorWithDescription:object] retain];
        if (col != nil)
        {
            [skyColor release];
            skyColor = [col copy];
            [col release];
            [UNIVERSE setLighting];
        }
    }
    else
    {
        OOLogWARN(@"script.warning", @"Change to property '%@' not applied, will apply only on leaving and re-entering this system.",key);
        return NO;
    }
    return YES;
}

References OOColor::colorWithDescription:, nil, OOLogWARN, and skyColor.

Referenced by Universe::setSystemDataForGalaxy:planet:key:value:fromManifest:forLayer:.

Here is the call graph for this function:

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Reimplemented from OOEntityWithDrawable.

Definition at line 150 of file SkyEntity.m.

{
    [skyColor release];
    
    [super dealloc];
}

References OOEntityWithDrawable::dealloc, and dealloc.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

descriptionForObjDump

- (NSString *) descriptionForObjDump

implementation

Reimplemented from Entity.

Definition at line 246 of file SkyEntity.m.

{
    // Don't include range and visibility flag as they're irrelevant.
    return [self descriptionForObjDumpBasic];
}

References descriptionForObjDump, and Entity::descriptionForObjDumpBasic.

Referenced by descriptionForObjDump.

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 OOEntityWithDrawable.

Definition at line 235 of file SkyEntity.m.

                      :(bool)immediate translucent:(bool)translucent
{
    if ([UNIVERSE breakPatternHide])  return;
    
    [super drawImmediate:immediate translucent:translucent];
    
    OOCheckOpenGLErrors(@"SkyEntity after drawing %@", self);
}

References OOEntityWithDrawable::drawImmediate:translucent:, OOCheckOpenGLErrors(), and UNIVERSE.

Here is the call graph for this function:

initWithColors:col1:andSystemInfo:

- (id) initWithColors:		(OOColor *)
col1:		(OOColor *)	col2
andSystemInfo:		(NSDictionary *)	systemInfo

Definition at line 55 of file SkyEntity.m.

                     :(OOColor *)col1 :(OOColor *)col2 andSystemInfo:(NSDictionary *)systemInfo
{
    OOSkyDrawable           *skyDrawable;
    float                   clusterChance,
                            alpha,
                            scale,
                            starCountMultiplier, 
                            nebulaCountMultiplier;
    signed                  starCount,  // Need to be able to hold -1...
                            nebulaCount;
    
    self = [super init];
    if (self == nil)  return nil;
    
    OOColor *col3 = [OOColor colorWithDescription:col1];
    OOColor *col4 = [OOColor colorWithDescription:col2];
 
    // Load colours
    BOOL nebulaColorSet = [self readColor1:&col1 andColor2:&col2 andColor3:&col3 andColor4:&col4 fromDictionary:systemInfo];
    
    skyColor = [[OOColor colorWithDescription:[systemInfo objectForKey:@"sun_color"]] retain];
    if (skyColor == nil)
    {
        skyColor = [[col2 blendedColorWithFraction:0.5 ofColor:col1] retain];
    }
    
    // Load distribution values
    clusterChance = [systemInfo oo_floatForKey:@"sky_blur_cluster_chance" defaultValue:SKY_clusterChance];
    alpha = [systemInfo oo_floatForKey:@"sky_blur_alpha" defaultValue:SKY_alpha];
    scale = [systemInfo oo_floatForKey:@"sky_blur_scale" defaultValue:SKY_scale];
    
    // Load star count
    starCount = [systemInfo oo_floatForKey:@"sky_n_stars" defaultValue:-1];
    starCountMultiplier = [systemInfo oo_floatForKey:@"star_count_multiplier" defaultValue:1.0f];
    if (starCountMultiplier < 0.0f)  starCountMultiplier *= -1.0f;
    if (0 <= starCount)
    {
        // changed for 1.82, default set to 1
        // lets OXPers modify the broad number without stopping variation
        starCount *= starCountMultiplier;
    }
    else
    {
        starCount = starCountMultiplier * SKY_BASIS_STARS * (0.5 + randf());
    }
    
    // ...and nebula count. (Note: simplifying this would change the appearance of stars/blobs.)
    nebulaCount = [systemInfo oo_floatForKey:@"sky_n_blurs" defaultValue:-1];
    nebulaCountMultiplier = [systemInfo oo_floatForKey:@"nebula_count_multiplier" defaultValue:1.0f];
    if (nebulaCountMultiplier < 0.0f)  nebulaCountMultiplier *= -1.0f;
    if (0 <= nebulaCount)
    {
        // changed for 1.82, default set to 1
        // lets OXPers modify the broad number without stopping variation
        nebulaCount *= nebulaCountMultiplier;
    }
    else
    {
        nebulaCount = nebulaCountMultiplier * SKY_BASIS_BLOBS * (0.5 + randf());
    }
    
    if ([UNIVERSE reducedDetail]) 
    {
        // limit stars and blobs to basis levels, and halve stars again
        if (starCount > SKY_BASIS_STARS)
        {
            starCount = SKY_BASIS_STARS;
        }
        starCount /= 2; 
        if (nebulaCount > SKY_BASIS_BLOBS)
        {
            nebulaCount = SKY_BASIS_BLOBS;
        }
    }
    
    skyDrawable = [[OOSkyDrawable alloc]
                   initWithColor1:col1
                   Color2:col2
                   Color3:col3
                   Color4:col4
                   starCount:starCount
                   nebulaCount:nebulaCount
                   nebulaHueFix:nebulaColorSet
                   clusterFactor:clusterChance
                   alpha:alpha
                   scale:scale];
    [self setDrawable:skyDrawable];
    [skyDrawable release];
    
    [self setStatus:STATUS_EFFECT];
    
    return self;
}

References OOColor::blendedColorWithFraction:ofColor:, OOColor::colorWithDescription:, Entity::init, nil, randf(), readColor1:andColor2:andColor3:andColor4:fromDictionary:, OOEntityWithDrawable::setDrawable:, Entity::setStatus:, SKY_BASIS_BLOBS, SKY_BASIS_STARS, skyColor, and UNIVERSE.

Here is the call graph for this function:

isSky

- (BOOL) isSky

implementation

Reimplemented from Entity.

Definition at line 205 of file SkyEntity.m.

{
    return YES;
}

References isSky.

Referenced by isSky.

Here is the call graph for this function:

Here is the caller graph for this function:

isVisible

- (BOOL) isVisible

implementation

Reimplemented from Entity.

Definition at line 211 of file SkyEntity.m.

{
    return YES;
}

References isVisible.

Referenced by isVisible.

Here is the call graph for this function:

Here is the caller graph for this function:

readColor1:andColor2:andColor3:andColor4:fromDictionary:

- (BOOL) readColor1: (OOColor **) ioColor1 andColor2: (OOColor **) ioColor2 andColor3: (OOColor **) ioColor3 andColor4: (OOColor **) ioColor4 fromDictionary: (NSDictionary *) dictionary

implementation

Provided by category SkyEntity(OOPrivate).

Definition at line 258 of file SkyEntity.m.

                  :(OOColor **)ioColor1 andColor2:(OOColor **)ioColor2 andColor3:(OOColor **)ioColor3 andColor4:(OOColor **)ioColor4 fromDictionary:(NSDictionary *)dictionary
{
    NSString            *string = nil;
    NSArray             *tokens = nil;
    id                  colorDesc = nil;
    OOColor             *color = nil;
    BOOL                nebulaSet = NO;
 
    assert(ioColor1 != NULL && ioColor2 != NULL);
    
    string = [dictionary oo_stringForKey:@"sky_rgb_colors"];
    if (string != nil)
    {
        tokens = ScanTokensFromString(string);
        
        if ([tokens count] == 6)
        {
            float r1 = OOClamp_0_1_f([tokens oo_floatAtIndex:0]);
            float g1 = OOClamp_0_1_f([tokens oo_floatAtIndex:1]);
            float b1 = OOClamp_0_1_f([tokens oo_floatAtIndex:2]);
            float r2 = OOClamp_0_1_f([tokens oo_floatAtIndex:3]);
            float g2 = OOClamp_0_1_f([tokens oo_floatAtIndex:4]);
            float b2 = OOClamp_0_1_f([tokens oo_floatAtIndex:5]);
            *ioColor1 = [OOColor colorWithRed:r1 green:g1 blue:b1 alpha:1.0];
            *ioColor2 = [OOColor colorWithRed:r2 green:g2 blue:b2 alpha:1.0];
        }
        else
        {
            OOLogWARN(@"sky.fromDict", @"could not interpret \"%@\" as two RGB colours (must be six numbers).", string);
        }
    }
    colorDesc = [dictionary objectForKey:@"sky_color_1"];
    if (colorDesc != nil)
    {
        color = [[OOColor colorWithDescription:colorDesc] premultipliedColor];
        if (color != nil)  *ioColor1 = color;
        else  OOLogWARN(@"sky.fromDict", @"could not interpret \"%@\" as a colour.", colorDesc);
    }
    colorDesc = [dictionary objectForKey:@"sky_color_2"];
    if (colorDesc != nil)
    {
        color = [[OOColor colorWithDescription:colorDesc] premultipliedColor];
        if (color != nil)  *ioColor2 = color;
        else  OOLogWARN(@"sky.fromDict", @"could not interpret \"%@\" as a colour.", colorDesc);
    }
 
    colorDesc = [dictionary objectForKey:@"nebula_color_1"];
    if (colorDesc != nil)
    {
        color = [[OOColor colorWithDescription:colorDesc] premultipliedColor];
        if (color != nil)  
        {
            *ioColor3 = color;
            nebulaSet = YES;
        }
        else  OOLogWARN(@"sky.fromDict", @"could not interpret \"%@\" as a colour.", colorDesc);
    }
    else
    {
        colorDesc = [dictionary objectForKey:@"sky_color_1"];
        if (colorDesc != nil)
        {
            color = [[OOColor colorWithDescription:colorDesc] premultipliedColor];
            if (color != nil)  *ioColor3 = color;
            else  OOLogWARN(@"sky.fromDict", @"could not interpret \"%@\" as a colour.", colorDesc);
        }
    }
    
    colorDesc = [dictionary objectForKey:@"nebula_color_2"];
    if (colorDesc != nil)
    {
        color = [[OOColor colorWithDescription:colorDesc] premultipliedColor];
        if (color != nil) 
        {
            *ioColor4 = color;
            nebulaSet = YES;
        }
        else  OOLogWARN(@"sky.fromDict", @"could not interpret \"%@\" as a colour.", colorDesc);
    }
    else
    {
        colorDesc = [dictionary objectForKey:@"sky_color_2"];
        if (colorDesc != nil)
        {
            color = [[OOColor colorWithDescription:colorDesc] premultipliedColor];
            if (color != nil)  *ioColor4 = color;
            else  OOLogWARN(@"sky.fromDict", @"could not interpret \"%@\" as a colour.", colorDesc);
        }
    }
    return nebulaSet;
}

Referenced by initWithColors:col1:andSystemInfo:.

Here is the caller graph for this function:

skyColor

- (OOColor *) skyColor

References skyColor.

update:

- (void) update: (OOTimeDelta) delta_t

implementation

Reimplemented from Entity.

Definition at line 189 of file SkyEntity.m.

               :(OOTimeDelta) delta_t
{
    PlayerEntity *player = PLAYER;
    zero_distance = MAX_CLEAR_DEPTH * MAX_CLEAR_DEPTH;
    cam_zero_distance = zero_distance;
    if (player != nil) 
    {
        position = [player viewpointPosition];
    }
    else
    {
        OOLog(@"sky.warning", @"%@", @"PLAYER is nil");
    }
}

References Entity::cam_zero_distance, MAX_CLEAR_DEPTH, nil, OOLog, PLAYER, Entity::position, PlayerEntity::viewpointPosition, and Entity::zero_distance.

Here is the call graph for this function:

Member Data Documentation

skyColor

- (OOColor *) skyColor

protected

Definition at line 158 of file SkyEntity.m.

{
    return skyColor;
}

Referenced by changeProperty:withDictionary:, initWithColors:col1:andSystemInfo:, Universe::setLighting, Universe::setSystemDataForGalaxy:planet:key:value:fromManifest:forLayer:, and skyColor.

---

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

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