Class Star

Describes all celestial bodies (a combination of OrbitalObject, CanHaveRings)

Implements

Index

Constructors

Properties

aggregate asteroidField light mesh model ringsUniforms targetInfo type volumetricLightUniforms

Methods

computeCulling dispose getBoundingRadius getLight getRadius getTransform getTypeName updateMaterial

Constructors

constructor

new Star(model: StarModel, scene: Scene): Star
New Star
Parameters
- model: StarModel
  The seed of the star in [-1, 1]
- scene: Scene
Returns Star
- Defined in stellarObjects/star/star.ts:65

Properties

`Readonly`aggregate

aggregate: PhysicsAggregate

`Readonly`asteroidField

asteroidField: null | AsteroidField

Returns the asteroid belt of the object's ring, or null if the object has no rings

`Readonly`light

light: PointLight

`Readonly`mesh

mesh: Mesh

`Readonly`model

model: StarModel

`Readonly`ringsUniforms

ringsUniforms: null | RingsUniforms

Returns the uniforms used to render the rings, or null if the object has no rings

`Readonly`targetInfo

targetInfo: TargetInfo

`Readonly`type

type: STAR = OrbitalObjectType.STAR

`Readonly`volumetricLightUniforms

volumetricLightUniforms: VolumetricLightUniforms = ...

Methods

computeCulling

computeCulling(camera: Camera): void
Parameters
- camera: Camera
Returns void
Implementation of Cullable.computeCulling
- Defined in stellarObjects/star/star.ts:142

dispose

dispose(): void
Deletes all resources used by the Transformable object

Returns void
Implementation of StellarObjectBase.dispose
- Defined in stellarObjects/star/star.ts:146

getBoundingRadius

getBoundingRadius(): number
Returns the radius describing the max extent of the object from its center

Returns number
Implementation of StellarObjectBase.getBoundingRadius
- Defined in stellarObjects/star/star.ts:138

getLight

getLight(): PointLight
Returns PointLight
Implementation of StellarObjectBase.getLight
- Defined in stellarObjects/star/star.ts:122

getRadius

getRadius(): number
Returns the radius of the celestial body

Returns number
Implementation of StellarObjectBase.getRadius
- Defined in stellarObjects/star/star.ts:134

getTransform

getTransform(): TransformNode
Returns the transform node of the Transformable object

Returns TransformNode
Implementation of StellarObjectBase.getTransform
- Defined in stellarObjects/star/star.ts:118

getTypeName

getTypeName(): string
Returns the type name of the object. This is used as a short identifier in the UI Overlay of the object

Returns string
Implementation of StellarObjectBase.getTypeName
- Defined in stellarObjects/star/star.ts:126

updateMaterial

updateMaterial(deltaTime: number): void
Parameters
- deltaTime: number
Returns void
- Defined in stellarObjects/star/star.ts:130