Class GasPlanet

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

Implements

Index

Constructors

Properties

aggregate asteroidField atmosphereUniforms material model ringsUniforms targetInfo type

Methods

computeCulling dispose getBoundingRadius getRadius getTransform getTypeName updateMaterial

Constructors

constructor

new GasPlanet(model: GasPlanetModel, scene: Scene): GasPlanet
New Gas Planet
Parameters
- model: GasPlanetModel
  The model to create the planet from or a seed for the planet in [-1, 1]
- scene: Scene
Returns GasPlanet
- Defined in planets/gasPlanet/gasPlanet.ts:63

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`atmosphereUniforms

atmosphereUniforms: AtmosphereUniforms

`Readonly`material

material: GasPlanetMaterial

`Readonly`model

model: GasPlanetModel

`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: GAS_PLANET = OrbitalObjectType.GAS_PLANET

Methods

computeCulling

computeCulling(camera: Camera): void
Parameters
- camera: Camera
Returns void
Implementation of Cullable.computeCulling
- Defined in planets/gasPlanet/gasPlanet.ts:133

dispose

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

Returns void
Implementation of PlanetaryMassObjectBase.dispose
- Defined in planets/gasPlanet/gasPlanet.ts:138

getBoundingRadius

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

Returns number
Implementation of PlanetaryMassObjectBase.getBoundingRadius
- Defined in planets/gasPlanet/gasPlanet.ts:125

getRadius

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

Returns number
Implementation of PlanetaryMassObjectBase.getRadius
- Defined in planets/gasPlanet/gasPlanet.ts:121

getTransform

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

Returns TransformNode
Implementation of PlanetaryMassObjectBase.getTransform
- Defined in planets/gasPlanet/gasPlanet.ts:146

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 PlanetaryMassObjectBase.getTypeName
- Defined in planets/gasPlanet/gasPlanet.ts:129

updateMaterial

updateMaterial(stellarObjects: Transformable[], deltaSeconds: number): void
Parameters
- stellarObjects: Transformable[]
- deltaSeconds: number
Returns void
Implementation of PlanetaryMassObjectBase.updateMaterial
- Defined in planets/gasPlanet/gasPlanet.ts:117