Base Entity in the Virtex vxEngine which controls all Rendering and Provides position and world matrix updates to the other required entities. More...

Inheritance diagram for VerticesEngine.vxEntity:

Public Member Functions
bool	HasSandboxOption (SandboxOptions option)

	vxEntity (vxGameplaySceneBase scene)
	Initializes a new instance of the VerticesEngine.Entities.vxEntity class. The Base Entity Object for the Engine.

virtual object	Clone ()
	Clones this Entity.

virtual void	OnNewItemAdded (string itmekey)

T	AddComponent< T > ()
	Add's a component to this entitiy.

T	GetComponent< T > ()
	Get's a component from the collection.

virtual void	GetPropertyInfo (vxPropertiesControl propertyControl)

virtual void	OnBeforeEntitySerialize ()
	A method which allows for certain opperations to be preformed just before the entity is saved to a file.

virtual void	OnAfterEntityDeserialized ()
	A method which allows for certain opperations to be preformed after the entity is loaded from a file.

T	CastAs< T > ()

Public Member Functions inherited from VerticesEngine.vxGameObject
virtual void	OnEnabled ()
	Called on Component Enabled.

virtual void	OnDisabled ()
	Called on Component Disabled.

virtual void	OnSelected ()
	Called when Selected.

virtual void	OnUnSelected ()
	Called when Unselected.

virtual string	GetTitle ()
	Gets the title.

virtual Texture2D	GetIcon (int w, int h)
	Gets the icon for this game object. Override this to provide per-entity cusomtization.

	vxGameObject ()
	Creates a new vxGameObject.

void	Dispose ()
	Dispposes this Object.

virtual void	OnGraphicsRefresh ()
	Called when there is a reset or refresh of Graphic settings such as resolution or setting.

Public Attributes
SandboxOptions	EntitySandboxOptions
	Options for this entity in the sandbox. I.e. is it saveable, is it cullable, etc...

bool	KeepUpdating = true
	Whether or not too keep Updating the current Entity.

bool	RenderEvenInDebug = false
	Should it be Rendered in Debug.

Public Attributes inherited from VerticesEngine.vxGameObject
bool	OnlySelectInSandbox = false

Protected Member Functions
void	AddSandboxOption (SandboxOptions option)

void	RemoveSandboxOption (SandboxOptions option)

virtual vxEntityRenderer	CreateRenderer ()

override void	OnVisibilityChanged ()
	Called when an Objects Visibility Changes.

virtual vxMaterial	OnMapMaterialToMesh (vxModelMesh mesh)
	Applies the materials to the a corresponding mesh in the mesh renderer.

virtual void	OnFirstUpdate ()

virtual void	MarkForDisposal ()

override void	OnDisposed ()
	Called when the entity is disposed.

Protected Member Functions inherited from VerticesEngine.vxGameObject
virtual bool	HasId ()

virtual void	OnSelectionStateChange ()
	Called when the selection state changes.

virtual string	GetIdPrefix ()

Protected Attributes
BoundingSphere	m_boundingSphere = new BoundingSphere()

Properties
vxGameplaySceneBase	CurrentScene `[get]`
	Gets the current scene of the game.

List< vxComponent >	Components `[get]`
	List of Components attached to this Entity.

vxTransform	Transform `[get, set]`
	The transform for this entity.

BoundingSphere	BoundingShape `[get]`
	The Bounding Sphere which is used to do frustrum culling.

bool	IsEntityCullable `[get, set]`
	Should this entity be checked for culling. Items like the Sky box shouldn't ever be.

vxEntityRenderer	EntityRenderer `[get]`

Properties inherited from VerticesEngine.vxGameObject
bool	IsVisible `[get, set]`
	Is this Game Object currently visible? Note that an Object can be Enabled, but not visible.

bool	IsEnabled `[get, set]`
	Is this Game Object Enabled currently.

string	Id `[get, set]`
	A unqiue string id which allows references to items to be serialised between sessions.

Texture2D	DefaultTexture `[get]`
	Gets the default texture.

vxEnumSandboxStatus	SandboxState `[get]`
	State of the Entity which is triggered by the simulation.

vxSelectionState	SelectionState `[get, set]`
	Gets or sets the selection state.

vxSelectionState	PreviousSelectionState `[get]`
	Get's the previous selection state.

bool	IsDisposed `[get]`

Additional Inherited Members
Static Public Attributes inherited from VerticesEngine.vxGameObject
static List< string >	NameRegister = new List<string>()
	The name register.

Events inherited from VerticesEngine.vxGameObject
EventHandler< EventArgs >	Selected
	Event Fired when the Items Selection stat Changes too Hovered.

EventHandler< EventArgs >	UnSelected
	Event Fired when the Items Selection stat Changes too unselected (or unhovered)

Detailed Description

Base Entity in the Virtex vxEngine which controls all Rendering and Provides position and world matrix updates to the other required entities.

Constructor & Destructor Documentation

◆ vxEntity()

VerticesEngine.vxEntity.vxEntity ( vxGameplaySceneBase scene )

Initializes a new instance of the VerticesEngine.Entities.vxEntity class. The Base Entity Object for the Engine.

Parameters

scene The current Scene for this entity to be added to.

Member Function Documentation

◆ AddComponent< T >()

T VerticesEngine.vxEntity.AddComponent< T > ( )

Add's a component to this entitiy.

Template Parameters

T

Returns

Type Constraints

T

:

vxComponent

◆ CastAs< T >()

T VerticesEngine.vxEntity.CastAs< T > ( )

Type Constraints

T

:

vxEntity

◆ Clone()

virtual object VerticesEngine.vxEntity.Clone ( )

virtual

Clones this Entity.

Returns: A Clone copy of this object

◆ GetComponent< T >()

T VerticesEngine.vxEntity.GetComponent< T > ( )

Get's a component from the collection.

Template Parameters

T

Returns

Type Constraints

T

:

vxComponent

◆ OnAfterEntityDeserialized()

virtual void VerticesEngine.vxEntity.OnAfterEntityDeserialized ( )

virtual

A method which allows for certain opperations to be preformed after the entity is loaded from a file.

Reimplemented in VerticesEngine.Entities.vxImportedEntity3D, VerticesEngine.EnvTerrain.vxTerrainChunk, VerticesEngine.Editor.Entities.vxBoundingVolume, and VerticesEngine.vxWaterEntity.

◆ OnBeforeEntitySerialize()

virtual void VerticesEngine.vxEntity.OnBeforeEntitySerialize ( )

virtual

A method which allows for certain opperations to be preformed just before the entity is saved to a file.

Reimplemented in VerticesEngine.EnvTerrain.vxTerrainChunk, VerticesEngine.Editor.Entities.vxBoundingVolume, and VerticesEngine.vxWaterEntity.

◆ OnDisposed()

override void VerticesEngine.vxEntity.OnDisposed ( )

protectedvirtual

Called when the entity is disposed.

Reimplemented from VerticesEngine.vxGameObject.

Reimplemented in VerticesEngine.vxUtilCameraEntity, VerticesEngine.vxUtilCamera3D, VerticesEngine.Editor.Entities.vxGizmo, VerticesEngine.Editor.Entities.vxGizmoTransformationBaseEntity, VerticesEngine.Particles.vxParticle2D, VerticesEngine.Particles.vxParticle3D, VerticesEngine.Entities.vxSkyBox, VerticesEngine.vxEntity2D, VerticesEngine.vxEntity3D, VerticesEngine.vxWaterEntity, and VerticesEngine.Graphics.Rendering.vxStaticMeshBatchEntity.

◆ OnMapMaterialToMesh()

virtual vxMaterial VerticesEngine.vxEntity.OnMapMaterialToMesh ( vxModelMesh mesh )

protectedvirtual

Applies the materials to the a corresponding mesh in the mesh renderer.

Reimplemented in VerticesEngine.Editor.Entities.vxEditorEntity, VerticesEngine.Entities.vxImportedEntity3D, VerticesEngine.Entities.vxSkyBox, VerticesEngine.EnvTerrain.vxTerrainChunk, and VerticesEngine.vxWaterEntity.

◆ OnVisibilityChanged()

override void VerticesEngine.vxEntity.OnVisibilityChanged ( )

protectedvirtual

Called when an Objects Visibility Changes.

Reimplemented from VerticesEngine.vxGameObject.

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

/github/workspace/src/VerticesEngine/src.shared/Entities/vxEntity.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ vxEntity()

Member Function Documentation

◆ AddComponent< T >()

◆ CastAs< T >()

◆ Clone()

◆ GetComponent< T >()

◆ OnAfterEntityDeserialized()

◆ OnBeforeEntitySerialize()

◆ OnDisposed()

◆ OnMapMaterialToMesh()

◆ OnVisibilityChanged()