Class TelluricPlanet

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

Implements

Constructors

constructor

new TelluricPlanet(
    model:
        | DeepReadonly<TelluricSatelliteModel>
        | DeepReadonly<TelluricPlanetModel>,
    assets: RenderingAssets,
    scene: Scene,
): TelluricPlanet
New Telluric Planet
Parameters
- model: DeepReadonly<TelluricSatelliteModel> | DeepReadonly<TelluricPlanetModel>
  The model to build the planet or a seed for the planet in [-1, 1]
- assets: RenderingAssets
- scene: Scene
Returns TelluricPlanet
- Defined in src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:86

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: DeepReadonly<TelluricSatelliteModel> | DeepReadonly<TelluricPlanetModel>

`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 src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:206

dispose

dispose(
ringsLutPool: ItemPool<RingsProceduralPatternLut>,
cloudsLutPool: ItemPool<CloudsLut>,
): void
Parameters
- ringsLutPool: ItemPool<RingsProceduralPatternLut>
- cloudsLutPool: ItemPool<CloudsLut>
Returns void
- Defined in src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:210

getBoundingRadius

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

Returns number
Implementation of PlanetaryMassObjectBase.getBoundingRadius
- Defined in src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:202

getCloudsUniforms

getCloudsUniforms(): null | CloudsUniforms
Returns null | CloudsUniforms
- Defined in src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:177

getRadius

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

Returns number
Implementation of PlanetaryMassObjectBase.getRadius
- Defined in src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:198

getTransform

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

Returns TransformNode
Implementation of PlanetaryMassObjectBase.getTransform
- Defined in src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:173

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 src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:181

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 src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:190

updateMaterial

updateMaterial(stellarObjects: readonly PointLight[]): void
Parameters
- stellarObjects: readonly PointLight[]
Returns void
Implementation of PlanetaryMassObjectBase.updateMaterial
- Defined in src/ts/frontend/universe/planets/telluricPlanet/telluricPlanet.ts:194