Class TelluricPlanet

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

Implements

Constructors

constructor

new TelluricPlanet(
model: TelluricPlanetModel | TelluricSatelliteModel,
scene: Scene,
): TelluricPlanet
New Telluric Planet
Parameters
- model: TelluricPlanetModel | TelluricSatelliteModel
  The model to build the planet or a seed for the planet in [-1, 1]
- scene: Scene
Returns TelluricPlanet
- Defined in planets/telluricPlanet/telluricPlanet.ts:76

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: null | AtmosphereUniforms

`Readonly`cloudsUniforms

cloudsUniforms: null | CloudsUniforms

`Readonly`material

material: TelluricPlanetMaterial

`Readonly`model

model: TelluricPlanetModel | TelluricSatelliteModel

`Readonly`oceanUniforms

oceanUniforms: null | OceanUniforms

`Readonly`ringsUniforms

ringsUniforms: null | RingsUniforms

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

`Readonly`sides

sides: ChunkTree[]

`Readonly`targetInfo

targetInfo: TargetInfo

`Readonly`type

type: TELLURIC_PLANET | TELLURIC_SATELLITE

Methods

computeCulling

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

dispose

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

Returns void
Implementation of PlanetaryMassObjectBase.dispose
- Defined in planets/telluricPlanet/telluricPlanet.ts:188

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/telluricPlanet/telluricPlanet.ts:180

getCloudsUniforms

getCloudsUniforms(): null | CloudsUniforms
Returns null | CloudsUniforms
- Defined in planets/telluricPlanet/telluricPlanet.ts:155

getRadius

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

Returns number
Implementation of PlanetaryMassObjectBase.getRadius
- Defined in planets/telluricPlanet/telluricPlanet.ts:176

getTransform

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

Returns TransformNode
Implementation of PlanetaryMassObjectBase.getTransform
- Defined in planets/telluricPlanet/telluricPlanet.ts:151

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/telluricPlanet/telluricPlanet.ts:159

updateLOD

updateLOD(observerPosition: Vector3, chunkForge: ChunkForge): void
Update terrain of the sphere relative to the observer position
Parameters
- observerPosition: Vector3
- chunkForge: ChunkForge
Returns void
- Defined in planets/telluricPlanet/telluricPlanet.ts:168

updateMaterial

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