OOSunEntity Class Reference

#include <OOSunEntity.h>

Inheritance diagram for OOSunEntity:

Collaboration diagram for OOSunEntity:

Instance Methods
(id)	- initSunWithColor:andDictionary:
(BOOL)	- setSunColor:
(BOOL)	- changeSunProperty:withDictionary:
(OOStellarBodyType)	- planetType
(void)	- getDiffuseComponents:
(void)	- getSpecularComponents:
(void)	- setRadius:andCorona:
(BOOL)	- willGoNova
(BOOL)	- goneNova
(void)	- setGoingNova:inTime:
(void)	- drawStarGlare
(void)	- drawDirectVisionSunGlare
(void)	- resetNova
(id)	- init [implementation]
(void)	- dealloc [implementation]
(NSString *)	- descriptionComponents [implementation]
(BOOL)	- canCollide [implementation]
(BOOL)	- checkCloseCollisionWith: [implementation]
(void)	- update: [implementation]
(void)	- drawImmediate:translucent: [implementation]
(void)	- updateCameraRelativePosition [implementation]
(void)	- drawOpaqueParts [implementation]
(void)	- drawTranslucentParts [implementation]
(void)	- calculateGLArrays:width:zDistance: [implementation]
(double)	- radius [implementation]
(void)	- setPosition: [implementation]
(BOOL)	- isSun [implementation]
(BOOL)	- isVisible [implementation]
(NSString *)	- name [implementation]
(void)	- setName: [implementation]
(BOOL)	- isVisibleToScripts [implementation]
(void)	- getJSClass:andPrototype: [implementation]
(NSString *)	- oo_jsClassName [implementation]
Instance Methods inherited from Entity
(NSUInteger)	- sessionID
(BOOL)	- isShip
(BOOL)	- isDock
(BOOL)	- isStation
(BOOL)	- isSubEntity
(BOOL)	- isPlayer
(BOOL)	- isPlanet
(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)	- setPositionX:y:z:
(HPVector)	- position
(Vector)	- cameraRelativePosition
(GLfloat)	- cameraRangeFront
(GLfloat)	- cameraRangeBack
(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:
(void)	- takeEnergyDamage:from:becauseOf:weaponIdentifier:
(void)	- dumpState
(void)	- dumpSelfState
(NSUInteger)	- lastDrawCounter
(void)	- setLastDrawCounter:
(double)	- findCollisionRadius
(BOOL)	- isInSpace
(BOOL)	- isImmuneToBreakPatternHide
(GLfloat)	- universalTime
(GLfloat)	- spawnTime
(GLfloat)	- timeElapsedSinceSpawn
(void)	- setAtmosphereFogging:
(OOColor *)	- fogUniform
(NSString *)	- descriptionForObjDumpBasic
(NSString *)	- descriptionForObjDump
(NSSet *)	- allTextures
(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

Private Attributes
GLfloat	sun_diffuse [4]
GLfloat	sun_specular [4]
GLfloat	discColor [4]
GLfloat	outerCoronaColor [4]
GLfloat	cor16k
GLfloat	lim16k
double	corona_speed_factor
double	corona_stage
GLfloat	rvalue [SUN_CORONA_SAMPLES]
float	corona_blending
GLuint	sunTriangles [3240 *3]
GLfloat	sunVertices [1801 *3]
GLfloat	sunColors [1801 *4]
OOTimeDelta	_novaCountdown
OOTimeDelta	_novaExpansionTimer
float	_novaExpansionRate
float	_sunBrightnessFactor
float	_sunCoronaAlphaFactor
NSString *	_name

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 54 of file OOSunEntity.h.

Method Documentation

calculateGLArrays:width:zDistance:

- (void) calculateGLArrays: (GLfloat)  inner_radius width: (GLfloat)  width zDistance: (GLfloat)  z_distance

implementation

Provided by category OOSunEntity(Private).

Definition at line 1 of file OOSunEntity.m.

                          :(GLfloat)inner_radius width:(GLfloat)width zDistance:(GLfloat)z_distance
{
//  if (EXPECT_NOT(inner_radius >= z_distance))  return;    // inside the sphere
    
    GLfloat activity[8] = {0.84, 0.74, 0.64, 0.54, 
                                                 0.3 , 0.4 , 0.7 , 0.8};
    
    GLfloat             si, ci;
    GLfloat             rv0, rv1, rv2, c0, c1, c2;
    GLfloat             pt0, pt1; 
    
    unsigned short      i, j, k;
    GLfloat             theta = 0.0f, delta;
    delta = M_PI / 180.0f;  // Convert step from degrees to radians
    pt0=(1.0 - corona_stage) * corona_blending;
    pt1=corona_stage * corona_blending;
 
    sunVertices[0] = 0.0;
    sunVertices[1] = 0.0;
    sunVertices[2] = 0.0;
    k = 3;
    for (j = 0 ; j <= 4 ; j++)
    {
        GLfloat r = inner_radius;
        switch (j) {
        case 4:
            r += width;
            break;
        case 3:
            r += width/1.5f;
            break;
        case 2:
            r += width/3.0f;
            break;
        case 1:
                r += width/15.0f;
            break;
        }
        theta = 0.0;
        for (i = 0 ; i < 360 ; i++)
        {
            GLfloat rm = 1.0;
            if (j >= 1 && j < 4)
            {
                rm = 1.0 + ((0.04/j)*(pt0 * (rvalue[i]+rvalue[i+1]+rvalue[i+2]) + pt1 * (rvalue[i+360]+rvalue[i+361]+rvalue[i+362])))/3;
            }
            GLfloat z = r * r * rm * rm / z_distance;
            si = sinf(theta);
            ci = cosf(theta);
            theta += delta;
            sunVertices[k++] = si * r * rm;
            sunVertices[k++] = ci * r * rm;
            sunVertices[k++] = -z;
        }
    }
 
    GLfloat blackColor[4] = {0.0,0.0,0.0,0.0};
    GLfloat *color = blackColor;
    GLfloat alpha = 0.0;
 
    k=0;
    sunColors[k++] = discColor[0];
    sunColors[k++] = discColor[1];
    sunColors[k++] = discColor[2];
    sunColors[k++] = discColor[3] * _sunCoronaAlphaFactor;
    
    for (j = 0 ; j <= 4 ; j++)
    {
        switch (j) {
        case 4:
            color = blackColor;
            alpha = 0.0;
            break;
        case 3:
            color = outerCoronaColor;
            alpha = 0.1;
            break;
        case 2:
            color = outerCoronaColor;
            alpha = 0.6;
            break;
        case 1:
            color = discColor;
            alpha = 0.95;
            break;
        case 0:
            color = discColor;
            alpha = 1.0;
            break;
        }
        for (i = 0 ; i < 360 ; i++)
        {
            if (j == 0) 
            {
                sunColors[k++] = color[0];
                sunColors[k++] = color[1];
                sunColors[k++] = color[2];
                sunColors[k++] = alpha * _sunCoronaAlphaFactor;
            }
            else
            {
                rv0 = pt0 * rvalue[i] + pt1 * rvalue[i + 360];
                rv1 = pt0 * rvalue[i + 1] + pt1 * rvalue[i + 361];
                rv2 = pt0 * rvalue[i + 2] + pt1 * rvalue[i + 362];
                c0 = color[0] * (activity[j-1] + rv0*activity[j+3]);
                c1 = color[1] * (activity[j-1] + rv1*activity[j+3]);
                c2 = color[2] * (activity[j-1] + rv2*activity[j+3]);
                if (c1 > c2 && c1 > c0)
                {
                    c1 = fmaxf(c0,c2);
                }
 
                sunColors[k++] = c0;
                sunColors[k++] = c1;
                sunColors[k++] = c2;
                sunColors[k++] = alpha * _sunCoronaAlphaFactor;
            }   
        }
    }
}

canCollide

- (BOOL) canCollide

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

{
    return YES;
}

changeSunProperty:withDictionary:

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

Definition at line 1 of file OOSunEntity.m.

                          :(NSString *)key withDictionary:(NSDictionary*) dict
{
    id  object = [dict objectForKey:key];
    static GLfloat oldRadius = 0.0;
    if ([key isEqualToString:@"sun_radius"])
    {
        oldRadius = [object doubleValue];   // clamp corona_flare in case planetinfo.plist / savegame contains the wrong value
        [self setRadius:oldRadius andCorona:[dict oo_floatForKey:@"corona_flare" defaultValue:0.0f]];
    }
    else if ([key isEqualToString:KEY_SUNNAME])
    {
        [self setName:[dict oo_stringForKey:KEY_SUNNAME]];
    }
    else if ([key isEqualToString:@"corona_flare"])
    {
        [self setRadius:collision_radius andCorona:[object floatValue]];
    }
    else if ([key isEqualToString:@"corona_shimmer"])
    {
        corona_speed_factor=OOClamp_0_1_f([object floatValue]) * 2.0 + randf() * randf();
    }
    else if ([key isEqualToString:@"corona_hues"])
    {
        corona_blending=OOClamp_0_1_f([object floatValue]);
    }
    else if ([key isEqualToString:@"sun_gone_nova"])
    {
 
        if ([dict oo_boolForKey:key])
        {
            [self setGoingNova:YES inTime:0];
        }
        else
        {
            [self setGoingNova:NO inTime:0];
            // oldRadius is always the radius we had before going nova...
            [self setRadius: oldRadius andCorona:[dict oo_floatForKey:@"corona_flare" defaultValue:0.0f]];
 
        }
    }
    else
    {
        OOLogWARN(@"script.warning", @"Change to property '%@' not applied, will apply only after leaving this system.",key);
        return NO;
    }
    return YES;
}

checkCloseCollisionWith:

- (BOOL) checkCloseCollisionWith: (Entity *)  other

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

                                :(Entity *)other
{
    if (gDebugFlags & DEBUG_COLLISIONS)
    {
        OOLog(@"sun.collide", @"%@", @"SUN Collision!");
    }
    
    return [super checkCloseCollisionWith:other];
}

dealloc

- (void) dealloc

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

{
    DESTROY(_name);
    [super dealloc];
}

descriptionComponents

- (NSString *) descriptionComponents

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

{
    NSString *result = [NSString stringWithFormat:@"ID: %u position: %@ radius: %.3fkm", [self universalID], HPVectorDescription([self position]), 0.001 * [self radius]];
    if ([self goneNova])
    {
        result = [result stringByAppendingString:@" (gone nova)"];
    }
    else if ([self willGoNova])
    {
        result = [result stringByAppendingString:@" (will go nova)"];
    }
    
    return result;
}

drawDirectVisionSunGlare

- (void) drawDirectVisionSunGlare

Definition at line 1 of file OOSunEntity.m.

{
#if SUN_DIRECT_VISION_GLARE
    OO_ENTER_OPENGL();
    
    OOSetOpenGLState(OPENGL_STATE_OVERLAY);
    
    GLfloat sunGlareAngularSize = atan([self radius]/HPdistance([PLAYER viewpointPosition], [self position])) * SUN_GLARE_MULT_FACTOR + (SUN_GLARE_ADD_FACTOR);
 
    GLfloat directVisionSunGlare = [PLAYER lookingAtSunWithThresholdAngleCos:cosf(sunGlareAngularSize)];
    if (directVisionSunGlare)
    {
        NSSize  siz =   [[UNIVERSE gui] size];
        MyOpenGLView *gameView = [UNIVERSE gameView];
        GLfloat aspectRatio = ([gameView viewSize].width / [gameView viewSize].height);
        GLfloat z  = [gameView display_z] / (aspectRatio > 4.0f/3.0f ? aspectRatio : 1.0f / aspectRatio);
        GLfloat atmosphericReductionFactor =  1.0f - [PLAYER insideAtmosphereFraction];
        // 182: square of ratio of radius to sun-witchpoint distance
        // in default Lave
        GLfloat distanceReductionFactor = OOClamp_0_1_f(([self radius] * [self radius] * 182.0) / HPdistance2([PLAYER position], [self position]));
        GLfloat sunGlareFilterMultiplierLocal = [PLAYER sunGlareFilter];
        GLfloat directVisionSunGlareColor[4] = {discColor[0], discColor[1], discColor[2], directVisionSunGlare *
                                                    atmosphericReductionFactor * distanceReductionFactor * 
                                                    (1.0f - sunGlareFilterMultiplierLocal) * 0.0085f};
                                                    
        OOGL(glColor4fv(directVisionSunGlareColor));
        
        OOGLBEGIN(GL_QUADS);
        glVertex3f(siz.width, siz.height, z);
        glVertex3f(siz.width, -siz.height, z);
        glVertex3f(-siz.width, -siz.height, z);
        glVertex3f(-siz.width, siz.height, z);
        OOGLEND();
    }
#endif
}

drawImmediate:translucent:

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

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

                      :(bool)immediate translucent:(bool)translucent
{
    if (![UNIVERSE breakPatternHide])
    {
        if (translucent)
        {
            // nothing...
        }
        else
        {
            [self drawOpaqueParts];
            /* Despite the side effects, we have to draw the translucent
             * parts on the opaque pass. Planets, at long range, aren't
             * depth-buffered. So if the translucent parts are drawn on the
             * translucent pass, they appear in front of planets they are
             * actually behind. Telabe in G3 is a good one to test with if
             * you have any clever ideas.
             *
             * - CIM 8/7/2013 */
            [self drawTranslucentParts];
        }
    }
}

drawOpaqueParts

- (void) drawOpaqueParts

implementation

Provided by category OOSunEntity(Private).

Definition at line 1 of file OOSunEntity.m.

{
    float sqrt_zero_distance = sqrt(cam_zero_distance);
    float effective_radius = collision_radius;
    float effective_cor16k = cor16k;
 
    /* At very long ranges the floating point inaccuracies make a
     * complete mess of the calculations, so if the sun is more than
     * 1E9 away, draw it closer but smaller. Painter's algorithm
     * should stop oddities with planets transiting it */
    float large_distance_compensator = sqrt_zero_distance / 1000000000.0f; //1E9
    if (large_distance_compensator > 1.0f)
    {
        sqrt_zero_distance /= large_distance_compensator;
        effective_radius /= large_distance_compensator;
        effective_cor16k /= large_distance_compensator;
    }
 
    OO_ENTER_OPENGL();
    
    OOSetOpenGLState(OPENGL_STATE_ADDITIVE_BLENDING);
 
    if ([UNIVERSE reducedDetail])
    {   
        int subdivideLevel = 2;     // 4 is probably the maximum!
        float drawFactor = [[UNIVERSE gameView] viewSize].width / 100.0;
        float drawRatio2 = drawFactor * effective_radius / sqrt_zero_distance; // equivalent to size on screen in pixels
    
        if (cam_zero_distance > 0.0f)
        {
            subdivideLevel = 2 + floorf(drawRatio2);
            if (subdivideLevel > 4)
                subdivideLevel = 4;
        }
    
    /*
     
    The depth test gets disabled in parts of this and instead
    we rely on the painters algorithm instead.
     
    The depth buffer isn't granular enough to cope with huge objects at vast
    distances.
     
    */
        BOOL ignoreDepthBuffer = cam_zero_distance > effective_radius * effective_radius * 25;
    
        int steps = 2 * (MAX_SUBDIVIDE - subdivideLevel);
 
        // Close enough not to draw flat?
        if (ignoreDepthBuffer)  OOGL(glDisable(GL_DEPTH_TEST));
        
        OOGL(glColor3fv(discColor));
        // FIXME: use vertex arrays
        OOGL(glDisable(GL_BLEND));
        OOGLBEGIN(GL_TRIANGLE_FAN);
        GLDrawBallBillboard(effective_radius, steps, sqrt_zero_distance);
        OOGLEND();
        OOGL(glEnable(GL_BLEND));
 
        if (ignoreDepthBuffer)  OOGL(glEnable(GL_DEPTH_TEST)); 
    
    }
    else
    {
        [self calculateGLArrays:effective_radius
                          width:effective_cor16k
                      zDistance:sqrt_zero_distance];
        OOGL(glDisable(GL_BLEND));
        OOGL(glVertexPointer(3, GL_FLOAT, 0, sunVertices));
        
        OOGL(glEnableClientState(GL_COLOR_ARRAY));
        OOGL(glColorPointer(4, GL_FLOAT, 0, sunColors));
        
        OOGL(glDrawElements(GL_TRIANGLES, 3*360, GL_UNSIGNED_INT, sunTriangles));
 
        OOGL(glDisableClientState(GL_COLOR_ARRAY));
        OOGL(glEnable(GL_BLEND));
 
        
    }
    
    OOVerifyOpenGLState();
    OOCheckOpenGLErrors(@"SunEntity after drawing %@", self);
}

drawStarGlare

- (void) drawStarGlare

Definition at line 1 of file OOSunEntity.m.

{
    OO_ENTER_OPENGL();
 
    OOSetOpenGLState(OPENGL_STATE_OVERLAY);
    
    float sqrt_zero_distance = sqrtf(cam_zero_distance);
    float alt = sqrt_zero_distance - collision_radius;
    if (EXPECT_NOT(alt < 0))
    {
        return;
    }
    float corona = cor16k/SUN_GLARE_CORONA_FACTOR;
    if (corona > alt)
    {
        float alpha = (1-(alt/corona));
        float alphaMult = _sunCoronaAlphaFactor * alpha;
        alpha *= alphaMult;
        GLfloat glareColor[4] = {discColor[0], discColor[1], discColor[2], alpha};
        NSSize      siz =   [[UNIVERSE gui] size];
        MyOpenGLView *gameView = [UNIVERSE gameView];
        GLfloat aspectRatio = ([gameView viewSize].width / [gameView viewSize].height);
        GLfloat z  = [gameView display_z] / (aspectRatio > 4.0f/3.0f ? aspectRatio : 1.0f / aspectRatio);
        OOGL(glColor4fv(glareColor));
 
        OOGLBEGIN(GL_QUADS);
        glVertex3f(siz.width, siz.height, z);
        glVertex3f(siz.width, -siz.height, z);
        glVertex3f(-siz.width, -siz.height, z);
        glVertex3f(-siz.width, siz.height, z);
        OOGLEND();
 
    }
}

drawTranslucentParts

- (void) drawTranslucentParts

implementation

Provided by category OOSunEntity(Private).

Definition at line 1 of file OOSunEntity.m.

{
    if ([UNIVERSE reducedDetail]) 
    {
        return;
    }
    
    OO_ENTER_OPENGL();
    
    OOSetOpenGLState(OPENGL_STATE_ADDITIVE_BLENDING);
 
    OOGL(glVertexPointer(3, GL_FLOAT, 0, sunVertices));
 
    OOGL(glEnableClientState(GL_COLOR_ARRAY));
    OOGL(glColorPointer(4, GL_FLOAT, 0, sunColors));
    OOGL(glDrawElements(GL_TRIANGLES, 24*360, GL_UNSIGNED_INT, sunTriangles+(3*360)));
 
    OOGL(glDisableClientState(GL_COLOR_ARRAY));
 
 
}

getDiffuseComponents:

- (void) getDiffuseComponents:

(GLfloat[4])

components

Definition at line 1 of file OOSunEntity.m.

                             :(GLfloat[4])components
{
    NSParameterAssert(components != NULL);
    memcpy(components, sun_diffuse, sizeof sun_diffuse);
}

getJSClass:andPrototype:

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

implementation

Reimplemented from Entity.

Provided by category OOSunEntity(OOJavaScriptExtensions).

Definition at line 179 of file OOJSSun.m.

                  :(JSClass **)outClass andPrototype:(JSObject **)outPrototype
{
    *outClass = &sSunClass;
    *outPrototype = sSunPrototype;
}

getSpecularComponents:

- (void) getSpecularComponents:

(GLfloat[4])

components

Definition at line 1 of file OOSunEntity.m.

                              :(GLfloat[4])components
{
    NSParameterAssert(components != NULL);
    memcpy(components, sun_specular, sizeof sun_specular);
}

goneNova

- (BOOL) goneNova

Definition at line 1 of file OOSunEntity.m.

{
    return throw_sparks && _novaCountdown <= 0;
}

init

- (id) init

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

{
    assert(0);
    return nil;
}

initSunWithColor:andDictionary:

- (id) initSunWithColor:		(OOColor*)	sun_color
andDictionary:		(NSDictionary*)	dict

Definition at line 1 of file OOSunEntity.m.

                       :(OOColor *)sun_color andDictionary:(NSDictionary *) dict
{
    int         i;
    
    self = [super init];
    
    collision_radius = 100000.0; //  100km across
    
    scanClass = CLASS_NO_DRAW;
    
    _sunBrightnessFactor = [[NSUserDefaults standardUserDefaults] oo_floatForKey:@"sbf" defaultValue:80.0f];
    _sunCoronaAlphaFactor = [[NSUserDefaults standardUserDefaults] oo_floatForKey:@"scaf" defaultValue:0.005f];
    
    [self setSunColor:sun_color];
 
    [self setName:OOExpand([dict oo_stringForKey:KEY_SUNNAME defaultValue:@"[oolite-default-star-name]"])];
    
    corona_blending=OOClamp_0_1_f([dict oo_floatForKey:@"corona_hues" defaultValue:1.0f]);
    corona_speed_factor=[dict oo_floatForKey:@"corona_shimmer" defaultValue:-1.0];
    if(corona_speed_factor<0)
    {
        // from .22222 to 2
        corona_speed_factor = 1.0 / (0.5 + 2.0 * (randf() + randf()));
    }
    else
    {
        //on average:  0 = .25 , 1 = 2.25  -  the same sun should give the same random component
        corona_speed_factor=OOClamp_0_1_f(corona_speed_factor) * 2.0 + randf() * randf();
    }
#ifdef OO_DUMP_PLANETINFO
    OOLog(@"planetinfo.record",@"corona_shimmer = %f",corona_speed_factor);
#endif
 
    corona_stage = 0.0;
    for (i = 0; i < SUN_CORONA_SAMPLES; i++)
        rvalue[i] = randf();
    
    // set up the radius properties
    [self changeSunProperty:@"sun_radius" withDictionary:dict];
    
    unsigned k = 0;
    for (unsigned i=0 ; i < 360 ; i++)
    {
        unsigned j = (i+1)%360;
// disc
        sunTriangles[k++] = 0;
        sunTriangles[k++] = 1+i;
        sunTriangles[k++] = 1+j;
    }
    for (unsigned i=0 ; i < 360 ; i++)
    {
        unsigned j = (i+1)%360;
// ring 1
        sunTriangles[k++] = 1+i;
        sunTriangles[k++] = 1+j;
        sunTriangles[k++] = 361+i;
        sunTriangles[k++] = 1+j;
        sunTriangles[k++] = 361+i;
        sunTriangles[k++] = 361+j;
// ring 2
        sunTriangles[k++] = 361+i;
        sunTriangles[k++] = 361+j;
        sunTriangles[k++] = 721+i;
        sunTriangles[k++] = 361+j;
        sunTriangles[k++] = 721+i;
        sunTriangles[k++] = 721+j;
// ring 3
        sunTriangles[k++] = 721+i;
        sunTriangles[k++] = 721+j;
        sunTriangles[k++] = 1081+i;
        sunTriangles[k++] = 721+j;
        sunTriangles[k++] = 1081+i;
        sunTriangles[k++] = 1081+j;
// ring 4
        sunTriangles[k++] = 1081+i;
        sunTriangles[k++] = 1081+j;
        sunTriangles[k++] = 1441+i;
        sunTriangles[k++] = 1081+j;
        sunTriangles[k++] = 1441+i;
        sunTriangles[k++] = 1441+j;
    }
 
    return self;
}

isSun

- (BOOL) isSun

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

{
    return YES;
}

isVisible

- (BOOL) isVisible

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

{
    return YES;
}

isVisibleToScripts

- (BOOL) isVisibleToScripts

implementation

Reimplemented from Entity.

Provided by category OOSunEntity(OOJavaScriptExtensions).

Definition at line 179 of file OOJSSun.m.

{
    return YES;
}

name

- (NSString *) name

implementation

Reimplemented from <OOStellarBody>.

Definition at line 1 of file OOSunEntity.m.

{
    return _name;
}

oo_jsClassName

- (NSString *) oo_jsClassName

implementation

Reimplemented from Entity.

Provided by category OOSunEntity(OOJavaScriptExtensions).

Definition at line 179 of file OOJSSun.m.

{
    return @"Sun";
}

planetType

- (OOStellarBodyType) planetType

Reimplemented from <OOStellarBody>.

Definition at line 1 of file OOSunEntity.m.

{
    return STELLAR_TYPE_SUN;
}

radius

- (double) radius

implementation

Reimplemented from <OOStellarBody>.

Definition at line 1 of file OOSunEntity.m.

{
    return collision_radius;
}

resetNova

- (void) resetNova

Definition at line 1 of file OOSunEntity.m.

{
    _novaExpansionTimer = 0.0;
    _novaExpansionRate = 0.0f;
    _novaCountdown = 0.0;
}

setGoingNova:inTime:

- (void) setGoingNova:		(BOOL)	yesno
inTime:		(double)	interval

Definition at line 1 of file OOSunEntity.m.

                     :(BOOL) yesno inTime:(double)interval
{
    throw_sparks = yesno;
    if (throw_sparks)
    {
        _novaCountdown = fmax(interval, 0.0);
        OOLog(@"script.debug.setSunNovaIn", @"NOVA activated! time until Nova : %.1f s", _novaCountdown);
    }
    
    _novaExpansionTimer = 0;
    _novaExpansionRate = 10000;
}

Referenced by OOSunEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, and SunGoNova().

Here is the caller graph for this function:

setName:

- (void) setName: (NSString *)  name

implementation

Reimplemented from <OOStellarBody>.

Definition at line 1 of file OOSunEntity.m.

                :(NSString *)name
{
    [_name release];
    _name = [name retain];
}

setPosition:

- (void) setPosition: (HPVector)  posn

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

                    :(HPVector) posn
{
    [super setPosition: posn];
    [UNIVERSE setMainLightPosition: HPVectorToVector(posn)];
}

setRadius:andCorona:

- (void) setRadius:		(GLfloat)	rad
andCorona:		(GLfloat)	corona

Definition at line 1 of file OOSunEntity.m.

                  :(GLfloat) rad andCorona:(GLfloat)corona
{
    collision_radius = rad;
    if (corona < 0.01f) {
        corona = 0.01f;
    }
    cor16k = rad * 8 * corona;
 
    GLfloat corouter = rad * (1+(8*corona));
 
    lim16k = corouter * corouter * NO_DRAW_DISTANCE_FACTOR*NO_DRAW_DISTANCE_FACTOR;
}

setSunColor:

- (BOOL) setSunColor:

(OOColor*)

sun_color

Definition at line 1 of file OOSunEntity.m.

                    :(OOColor*)sun_color
{
    if (sun_color == nil) return NO;
    
    OO_ENTER_OPENGL();
    
    float       hue, sat, bri, alf;
    OOColor     *color = nil;
    
    // blend some white into the sun color to brighten it up
    sun_color = [sun_color blendedColorWithFraction:0.3 ofColor:[OOColor whiteColor]];
    
    [sun_color getHue:&hue saturation:&sat brightness:&bri alpha:&alf];
    hue /= 360;
    
/*
    // FIXME: do away with hue_drift altogether?
    // The following two lines are functionally identical to 1.73:
    randf();randf();    // avoid ranrot dirft!
    float hue_drift = 0.0f;
*/
    
    // anything more than a minimal hue drift will wipe out the original colour.
    float hue_drift = 0.0038f * fabsf(randf() - randf());
    
    // set the lighting color for the sun
    GLfloat     r,g,b,a;
    [sun_color getRed:&r green:&g blue:&b alpha:&a];
    
    GLfloat     sun_ambient[] = { 0.0, 0.0, 0.0, 1.0};  // real ambient light inside gl_LightModel.ambient
    sun_diffuse[0] = 0.5f * (1.0f + r); // paler
    sun_diffuse[1] = 0.5f * (1.0f + g); // paler
    sun_diffuse[2] = 0.5f * (1.0f + b); // paler
    sun_diffuse[3] = 1.0;
    sun_specular[0] = r;
    sun_specular[1] = g;
    sun_specular[2] = b;
    sun_specular[3] = 1.0;
    
    OOGL(glLightfv(GL_LIGHT1, GL_AMBIENT, sun_ambient));
    OOGL(glLightfv(GL_LIGHT1, GL_DIFFUSE, sun_diffuse));
    OOGL(glLightfv(GL_LIGHT1, GL_SPECULAR, sun_specular));
    
    // main disc less saturation (partially taken care of by the ACES tonemapper) more brightness
    color = [OOColor colorWithHue:hue saturation:sat * 0.75f brightness:1.0f alpha:1.0f];
    // our OpenGL color values are unclamped, so we can multiply the color components by
    // any value we want, in order to make the sun a truly bright object in the sky
    color = [OOColor colorWithRed:[color redComponent] * _sunBrightnessFactor green:[color greenComponent] * _sunBrightnessFactor blue:[color blueComponent] * _sunBrightnessFactor alpha:[color alphaComponent]];
    [color getRed:&discColor[0] green:&discColor[1] blue:&discColor[2] alpha:&discColor[3]];
    
    /*  Two inner corona layers with low alpha and saturation are additively
        blended with main corona. This produces something vaguely like a bloom
        effect.
    */
    hue += hue_drift * 3;
    // saturation = 1 would shift white to red
    color = [OOColor colorWithHue:hue saturation:OOClamp_0_1_f(sat*1.0f) brightness:bri * 0.75f alpha:0.45f];
    color = [OOColor colorWithRed:[color redComponent] * _sunBrightnessFactor green:[color greenComponent] * _sunBrightnessFactor blue:[color blueComponent] * _sunBrightnessFactor alpha:[color alphaComponent]];
    [color getRed:&outerCoronaColor[0] green:&outerCoronaColor[1] blue:&outerCoronaColor[2] alpha:&outerCoronaColor[3]];
    
    return YES;
}

update:

- (void) update: (OOTimeDelta)  delta_t

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

               :(OOTimeDelta) delta_t
{
    [super update:delta_t];
    
    PlayerEntity    *player = PLAYER;
    assert(player != nil);
    rotMatrix = OOMatrixForBillboard(position, [player viewpointPosition]);
    
    if (throw_sparks && _novaExpansionRate > 0.0f)  // going NOVA!
    {
        if (_novaCountdown >= 0.0)  // countdown
        {
            _novaCountdown -= delta_t;
            if (corona_speed_factor < 5.0)
            {
                corona_speed_factor += 0.75 * delta_t;
            }
        }
        else
        {
            if (_novaExpansionTimer <= 60.0)    // expand for a minute
            {
                double sky_bri = 1.0 - 1.5 * _novaExpansionTimer;
                if (sky_bri < 0)
                {
                    [UNIVERSE setSkyColorRed:0.0f       // back to black
                                       green:0.0f
                                        blue:0.0f
                                       alpha:0.0f];
                }
                else
                {
                    [UNIVERSE setSkyColorRed:sky_bri    // whiteout
                                       green:sky_bri
                                        blue:sky_bri
                                       alpha:1.0f];
                }
                if (sky_bri == 1.0)
                {   
                    // This sun has now gone nova!
                    [UNIVERSE setSystemDataKey:@"sun_gone_nova" value:[NSNumber numberWithBool:YES] fromManifest:@"org.oolite.oolite"];
                    [UNIVERSE setSystemDataKey:@"corona_flare" value:[NSNumber numberWithFloat:0.3] fromManifest:@"org.oolite.oolite"];
                    [UNIVERSE setSystemDataKey:@"corona_hues" value:[NSNumber numberWithFloat:0.05] fromManifest:@"org.oolite.oolite"];
                    // Novas are stored under the core manifest if the
                    // player was there at the time. Default layer 2
                    // is fine.
                    OOLog(@"sun.nova.start", @"DEBUG: NOVA original radius %.1f", collision_radius);
                }
                discColor[0] = 1.0 * _sunBrightnessFactor;  discColor[1] = 1.0 * _sunBrightnessFactor;  discColor[2] = 1.0 * _sunBrightnessFactor;
                _novaExpansionTimer += delta_t;
                [UNIVERSE setSystemDataKey:@"sun_radius" value:[NSNumber numberWithFloat:collision_radius + delta_t * _novaExpansionRate] fromManifest:@"org.oolite.oolite"];
            }
            else
            {
                OOLog(@"sun.nova.end", @"DEBUG: NOVA final radius %.1f", collision_radius);
                
                // reset at the new size
                [self resetNova];
                throw_sparks = YES; // keep throw_sparks at YES to indicate the higher temperature
            }
        }
    }
    
    // update corona
    if (![UNIVERSE reducedDetail])
    {
        corona_stage += corona_speed_factor * delta_t;
        while (corona_stage > 1.0)
        {
            int i;
            corona_stage -= 1.0;
            for (i = 0; i < 360; i++)
            {
                rvalue[i] = rvalue[360 + i];
                rvalue[360 + i] = randf();
            }
        }
    }
 
}

updateCameraRelativePosition

- (void) updateCameraRelativePosition

implementation

Reimplemented from Entity.

Definition at line 1 of file OOSunEntity.m.

{
    HPVector cr_temp = HPvector_subtract([self absolutePositionForSubentity],[PLAYER viewpointPosition]);
    /* Special calculation as suns viewed over ~1E9 - and the bigger
     * ones are still just about visible at this range - get floating
     * point errors messing up the display */
    if (EXPECT_NOT(HPmagnitude2(cr_temp) > 1E18))
    {
        cr_temp = HPvector_multiply_scalar(cr_temp,1E9/HPmagnitude(cr_temp));
    }
    cameraRelativePosition = HPVectorToVector(cr_temp);
}

willGoNova

- (BOOL) willGoNova

Definition at line 1 of file OOSunEntity.m.

{
    return throw_sparks;
}

Member Data Documentation

_name

- (NSString*) _name

private

Definition at line 82 of file OOSunEntity.h.

_novaCountdown

- (OOTimeDelta) _novaCountdown

private

Definition at line 75 of file OOSunEntity.h.

_novaExpansionRate

- (float) _novaExpansionRate

private

Definition at line 77 of file OOSunEntity.h.

_novaExpansionTimer

- (OOTimeDelta) _novaExpansionTimer

private

Definition at line 76 of file OOSunEntity.h.

_sunBrightnessFactor

- (float) _sunBrightnessFactor

private

Definition at line 79 of file OOSunEntity.h.

_sunCoronaAlphaFactor

- (float) _sunCoronaAlphaFactor

private

Definition at line 80 of file OOSunEntity.h.

cor16k

- (GLfloat) cor16k

private

Definition at line 64 of file OOSunEntity.h.

corona_blending

- (float) corona_blending

private

Definition at line 69 of file OOSunEntity.h.

corona_speed_factor

- (double) corona_speed_factor

private

Definition at line 66 of file OOSunEntity.h.

corona_stage

- (double) corona_stage

private

Definition at line 67 of file OOSunEntity.h.

discColor

- (GLfloat discColor[4])

private

Definition at line 61 of file OOSunEntity.h.

lim16k

- (GLfloat) lim16k

private

Definition at line 64 of file OOSunEntity.h.

outerCoronaColor

- (GLfloat outerCoronaColor[4])

private

Definition at line 62 of file OOSunEntity.h.

rvalue

- (GLfloat rvalue[SUN_CORONA_SAMPLES])

private

Definition at line 68 of file OOSunEntity.h.

sun_diffuse

- (GLfloat sun_diffuse[4])

private

Definition at line 58 of file OOSunEntity.h.

sun_specular

- (GLfloat sun_specular[4])

private

Definition at line 59 of file OOSunEntity.h.

sunColors

- (GLfloat sunColors[1801 *4])

private

Definition at line 73 of file OOSunEntity.h.

sunTriangles

- (GLuint sunTriangles[3240 *3])

private

Definition at line 71 of file OOSunEntity.h.

sunVertices

- (GLfloat sunVertices[1801 *3])

private

Definition at line 72 of file OOSunEntity.h.

---

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

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