Space Engineers
Classes | Public Member Functions | Properties | List of all members
Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent Class Reference
Inheritance diagram for Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent:
VRage.Game.Components.MyEntityComponentBase Sandbox.Game.WorldEnvironment.IMy2DClipmapManager Sandbox.Game.WorldEnvironment.IMyEnvironmentOwner VRage.Game.Components.MyComponentBase

Public Member Functions

 MyPlanetEnvironmentComponent ()
 
void InitEnvironment ()
 
void Update (bool doLazyUpdates=true, bool forceUpdate=false)
 
void DebugDraw ()
 
override void OnAddedToScene ()
 CH: TOOD: Be careful! This does not get called if the component is added to a container that is in the scene already! More...
 
override void OnRemovedFromScene ()
 CH: TOOD: Be careful! This does not get called if the component is removed from a container that is still in the scene! More...
 
override bool IsSerialized ()
 Tells the component container serializer whether this component should be saved More...
 
override MyObjectBuilder_ComponentBase Serialize (bool copy=false)
 
override void Deserialize (MyObjectBuilder_ComponentBase builder)
 
unsafe void QuerySurfaceParameters (Vector3D localOrigin, ref BoundingBoxD queryBounds, List< Vector3 > queries, List< MySurfaceParams > results)
 
MyEnvironmentSector GetSectorForPosition (Vector3D positionWorld)
 
MyEnvironmentSector GetSectorById (long packedSectorId)
 
void SetSectorPinned (MyEnvironmentSector sector, bool pinned)
 
IEnumerable< MyEnvironmentSectorGetSectorsInRange (MyShape shape)
 
int GetSeed ()
 
MyPhysicalModelDefinition GetModelForId (short id)
 
void GetDefinition (ushort index, out MyRuntimeEnvironmentItemInfo def)
 
void ProjectPointToSurface (ref Vector3D center)
 
void GetSurfaceNormalForPoint (ref Vector3D point, out Vector3D normal)
 
Vector3D[] GetBoundingShape (ref Vector3D worldPos, ref Vector3 basisX, ref Vector3 basisY)
 
short GetModelId (MyPhysicalModelDefinition def)
 
void ScheduleWork (MyEnvironmentSector sector, bool parallel)
 
List< MyOrientedBoundingBoxDGetCollidedBoxes (long sectorId)
 
void InitClearAreasManagement ()
 
MyLogicalEnvironmentSectorBase GetLogicalSector (long packedSectorId)
 
void CloseAll ()
 
bool TryGetSector (long id, out MyEnvironmentSector environmentSector)
 
- Public Member Functions inherited from VRage.Game.Components.MyEntityComponentBase
override void OnAddedToContainer ()
 Gets called after the container of this component changes More...
 
override void OnBeforeRemovedFromContainer ()
 Gets called before the removal of this component from a container More...
 
- Public Member Functions inherited from VRage.Game.Components.MyComponentBase
virtual void SetContainer (MyComponentContainer container)
 Sets the container of this component. Note that the component is not added to the container here! Therefore, use MyComponentContainer.Add(...) method and it will in turn call this method. Actually, you should seldom have the need to call this method yourself. More...
 
virtual T GetAs< T > ()
 
virtual void Init (MyComponentDefinitionBase definition)
 

Properties

int MaxLod [get]
 
override string ComponentTypeDebugString [get]
 
MyWorldEnvironmentDefinition EnvironmentDefinition [get]
 
IMyEnvironmentDataProvider DataProvider [get]
 
bool CollisionCheckEnabled [get]
 
- Properties inherited from VRage.Game.Components.MyEntityComponentBase
MyEntityComponentContainer Container [get]
 
IMyEntity Entity [get]
 
abstract string ComponentTypeDebugString [get]
 Name of the base component type for debug purposes (e.g.: "Position") More...
 
- Properties inherited from VRage.Game.Components.MyComponentBase
MyComponentContainer ContainerBase [get]
 This cannot be named Container to not conflict with the definition of Container in MyEntityComponentBase. More...
 
- Properties inherited from Sandbox.Game.WorldEnvironment.IMyEnvironmentOwner
MyWorldEnvironmentDefinition EnvironmentDefinition [get]
 
MyEntity Entity [get]
 

Additional Inherited Members

- Events inherited from VRage.Game.Components.MyEntityComponentBase
static Action< MyEntityComponentBaseOnAfterAddedToContainer
 
Action< MyEntityComponentBaseBeforeRemovedFromContainer
 

Detailed Description

Definition at line 30 of file MyPlanetEnvironmentComponent.cs.

Constructor & Destructor Documentation

Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.MyPlanetEnvironmentComponent ( )
inline

Definition at line 68 of file MyPlanetEnvironmentComponent.cs.

Member Function Documentation

void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.CloseAll ( )
inline

Definition at line 1057 of file MyPlanetEnvironmentComponent.cs.

void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.DebugDraw ( )
inline

Definition at line 269 of file MyPlanetEnvironmentComponent.cs.

override void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.Deserialize ( MyObjectBuilder_ComponentBase  builder)
inlinevirtual

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 533 of file MyPlanetEnvironmentComponent.cs.

Vector3D [] Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetBoundingShape ( ref Vector3D  worldPos,
ref Vector3  basisX,
ref Vector3  basisY 
)
inline
List<MyOrientedBoundingBoxD> Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetCollidedBoxes ( long  sectorId)
inline

Definition at line 925 of file MyPlanetEnvironmentComponent.cs.

void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetDefinition ( ushort  index,
out MyRuntimeEnvironmentItemInfo  def 
)
inline
MyLogicalEnvironmentSectorBase Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetLogicalSector ( long  packedSectorId)
inline

Definition at line 1050 of file MyPlanetEnvironmentComponent.cs.

MyPhysicalModelDefinition Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetModelForId ( short  id)
inline
short Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetModelId ( MyPhysicalModelDefinition  def)
inline
MyEnvironmentSector Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetSectorById ( long  packedSectorId)
inline
MyEnvironmentSector Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetSectorForPosition ( Vector3D  positionWorld)
inline
IEnumerable<MyEnvironmentSector> Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetSectorsInRange ( MyShape  shape)
inline

Definition at line 804 of file MyPlanetEnvironmentComponent.cs.

int Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetSeed ( )
inline
void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.GetSurfaceNormalForPoint ( ref Vector3D  point,
out Vector3D  normal 
)
inline
void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.InitClearAreasManagement ( )
inline

Definition at line 938 of file MyPlanetEnvironmentComponent.cs.

void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.InitEnvironment ( )
inline

Definition at line 74 of file MyPlanetEnvironmentComponent.cs.

override bool Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.IsSerialized ( )
inlinevirtual

Tells the component container serializer whether this component should be saved

Returns

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 501 of file MyPlanetEnvironmentComponent.cs.

override void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.OnAddedToScene ( )
inlinevirtual

CH: TOOD: Be careful! This does not get called if the component is added to a container that is in the scene already!

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 489 of file MyPlanetEnvironmentComponent.cs.

override void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.OnRemovedFromScene ( )
inlinevirtual

CH: TOOD: Be careful! This does not get called if the component is removed from a container that is still in the scene!

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 494 of file MyPlanetEnvironmentComponent.cs.

void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.ProjectPointToSurface ( ref Vector3D  center)
inline
unsafe void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.QuerySurfaceParameters ( Vector3D  localOrigin,
ref BoundingBoxD  queryBounds,
List< Vector3 queries,
List< MySurfaceParams results 
)
inline
void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.ScheduleWork ( MyEnvironmentSector  sector,
bool  parallel 
)
inline
override MyObjectBuilder_ComponentBase Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.Serialize ( bool  copy = false)
inlinevirtual

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 506 of file MyPlanetEnvironmentComponent.cs.

void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.SetSectorPinned ( MyEnvironmentSector  sector,
bool  pinned 
)
inline
bool Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.TryGetSector ( long  id,
out MyEnvironmentSector  environmentSector 
)
inline

Definition at line 1100 of file MyPlanetEnvironmentComponent.cs.

void Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.Update ( bool  doLazyUpdates = true,
bool  forceUpdate = false 
)
inline

Definition at line 129 of file MyPlanetEnvironmentComponent.cs.

Property Documentation

bool Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.CollisionCheckEnabled
get

Definition at line 923 of file MyPlanetEnvironmentComponent.cs.

override string Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.ComponentTypeDebugString
get

Definition at line 485 of file MyPlanetEnvironmentComponent.cs.

IMyEnvironmentDataProvider Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.DataProvider
get

Definition at line 845 of file MyPlanetEnvironmentComponent.cs.

MyWorldEnvironmentDefinition Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.EnvironmentDefinition
get

Definition at line 837 of file MyPlanetEnvironmentComponent.cs.

int Sandbox.Game.Entities.Planet.MyPlanetEnvironmentComponent.MaxLod
get

Definition at line 173 of file MyPlanetEnvironmentComponent.cs.


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