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.vxEntity3D:

Public Member Functions
	vxEntity3D (vxGameplayScene3D scene, Vector3 startPosition)
	Base Entity Object for the Engine.

	vxEntity3D (Vector3 startPosition)
	Base Entity Object for the Engine.

	vxEntity3D (vxMesh entityMesh, Vector3 startPosition)
	Base Entity Object for the Engine.

	vxEntity3D (vxGameplayScene3D scene, vxMesh entityMesh, Vector3 startPosition, vxEntityCategory entity3DType=vxEntityCategory.Entity)
	Base Entity Object for the Engine.

virtual void	RenderOverlayMesh (vxCamera3D Camera)
	Renders the overlay mesh.

Public Member Functions inherited from VerticesEngine.vxEntity
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
string	UserDefinedData

string	UserDefinedData01

string	UserDefinedData02

string	UserDefinedData03

string	UserDefinedData04

string	UserDefinedData05

object	Tag = ""

bool	CanBePlacedOnSurface = false

vxTransform	PreSelectionWorld = vxTransform.Identity

readonly vxEntityCategory	m_sandboxEntityType

string	Description
	Description of the Entity.

string	ItemKey = "<none>"

Public Attributes inherited from VerticesEngine.vxEntity
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	OverrideSelectionWithOtherEntity (vxEntity3D entity)
	This promotes another entity to be selected when this one is,.

virtual void	OnWorldTransformChanged ()
	Fired when the World Matrix is Updated or changed. Helpful for entities which are dependant on this one.

void	SetStartPosition (Vector3 startPOs)

virtual void	OnRenderScaleChanged ()

override vxEntityRenderer	CreateRenderer ()

void	MapMaterialsToMesh (vxMesh model)

virtual void	OnRefreshMaterialTextures (vxModelMesh mesh, vxMaterial material)
	This refreshes the textures for this material, useful if the mesh has changed and the materials require new meshes.

virtual vxMesh	OnLoadModel ()
	This method is fired if a model is not passed through the constructor of if 'null' is passed. This is handy for specifing different models for different conditions for a certain Entity as well as althoughts the model not to be loaded until needed.

virtual void	InitShaders ()
	Initialise the Main Shader.

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

override void	OnFirstUpdate ()

virtual BoundingSphere	GetBoundingShape ()

Protected Member Functions inherited from VerticesEngine.vxEntity
void	AddSandboxOption (SandboxOptions option)

void	RemoveSandboxOption (SandboxOptions option)

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	MarkForDisposal ()

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

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

virtual string	GetIdPrefix ()

Properties
int	HandleID `[get]`
	The handle identifier for this entity.

vxGameplayScene3D	Scene `[get]`
	The current scene of the game.

new vxGameplayScene3D	CurrentScene `[get]`

Vector3	Position `[get, set]`
	Location of Entity in world space.

Vector3	Rotation `[get, set]`

Vector3	Scale `[get, set]`

Vector3	StartPosition `[get]`
	The Start Position of the Entity.

float	RenderScale `[get, set]`

BoundingBox	BoundingBox `[get]`
	Item Bounding Box.

Vector3	ModelCenter `[get, set]`
	The Model Center. This is not to be confused with the Model Position.

vxEntityCategory	SandboxEntityType `[get]`
	The type of the sandbox entity.

Color	SelectionColour `[get, set]`

vxMeshRenderer	MeshRenderer `[get]`
	The mesh renderer for this entity.

vxMesh	Model `[get, set]`
	The vxModel model which holds are graphical, shader and vertices data to be shown.

bool	IsMotionBlurEnabled `[get, set]`

float	MotionBlurFactor `[get, set]`

Properties inherited from VerticesEngine.vxEntity
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.

Protected Attributes inherited from VerticesEngine.vxEntity
BoundingSphere	m_boundingSphere = new BoundingSphere()

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

◆ vxEntity3D() [1/4]

VerticesEngine.vxEntity3D.vxEntity3D	(	vxGameplayScene3D	scene,
		Vector3	startPosition )

Base Entity Object for the Engine.

If a model is not specefied, this entity will call the GetModel() method. Override this method with the and return the model for this Entity. Otherwise this Entity is used as an 'Empty' in the Engine.

Parameters

scene	The current Scene that will own this entity.
startPosition	The Start Position of the Entity

◆ vxEntity3D() [2/4]

VerticesEngine.vxEntity3D.vxEntity3D ( Vector3 startPosition )

Base Entity Object for the Engine.

If a model is not specefied, this entity will call the GetModel() method. Override this method with the and return the model for this Entity. Otherwise this Entity is used as an 'Empty' in the Engine.

Parameters

Scene	The current Scene that will own this entity.
startPosition	The Start Position of the Entity

◆ vxEntity3D() [3/4]

VerticesEngine.vxEntity3D.vxEntity3D	(	vxMesh	entityMesh,
		Vector3	startPosition )

Base Entity Object for the Engine.

If a model is not specefied, this entity will call the GetModel() method. Override this method with the and return the model for this Entity. Otherwise this Entity is used as an 'Empty' in the Engine.

Parameters

entityMesh	The mesh to use with this entity.
startPosition	The Start Position of the Entity

◆ vxEntity3D() [4/4]

VerticesEngine.vxEntity3D.vxEntity3D	(	vxGameplayScene3D	scene,
		vxMesh	entityMesh,
		Vector3	startPosition,
		vxEntityCategory	entity3DType = vxEntityCategory::Entity )

Base Entity Object for the Engine.

Parameters

scene	The current Scene that will own this entity.
entityMesh	The Entities Model to be used.
startPosition	The Start Position of the Entity.

Member Function Documentation

◆ CreateRenderer()

override vxEntityRenderer VerticesEngine.vxEntity3D.CreateRenderer ( )

protectedvirtual

Reimplemented from VerticesEngine.vxEntity.

◆ InitShaders()

virtual void VerticesEngine.vxEntity3D.InitShaders ( )

protectedvirtual

Initialise the Main Shader.

If a different shader is applied to this model, this method should be overridden

Reimplemented in VerticesEngine.Editor.Entities.vxBoundingVolume.

◆ OnDisposed()

override void VerticesEngine.vxEntity3D.OnDisposed ( )

protectedvirtual

Called when the entity is disposed.

Reimplemented from VerticesEngine.vxEntity.

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

◆ OnFirstUpdate()

override void VerticesEngine.vxEntity3D.OnFirstUpdate ( )

protectedvirtual

Reimplemented from VerticesEngine.vxEntity.

◆ OnLoadModel()

virtual vxMesh VerticesEngine.vxEntity3D.OnLoadModel ( )

protectedvirtual

This method is fired if a model is not passed through the constructor of if 'null' is passed. This is handy for specifing different models for different conditions for a certain Entity as well as althoughts the model not to be loaded until needed.

Returns

◆ OnRefreshMaterialTextures()

virtual void VerticesEngine.vxEntity3D.OnRefreshMaterialTextures	(	vxModelMesh	mesh,
		vxMaterial	material )

protectedvirtual

This refreshes the textures for this material, useful if the mesh has changed and the materials require new meshes.

Reimplemented in VerticesEngine.Entities.vxImportedEntity3D.

◆ OnWorldTransformChanged()

virtual void VerticesEngine.vxEntity3D.OnWorldTransformChanged ( )

protectedvirtual

Fired when the World Matrix is Updated or changed. Helpful for entities which are dependant on this one.

Reimplemented in VerticesEngine.vxUtilCameraEntity, VerticesEngine.Util.vxSnapBox, VerticesEngine.Editor.Entities.vxBoundingVolume, and VerticesEngine.vxWaterEntity.

◆ OverrideSelectionWithOtherEntity()

void VerticesEngine.vxEntity3D.OverrideSelectionWithOtherEntity ( vxEntity3D entity )

protected

This promotes another entity to be selected when this one is,.

Parameters

entity

◆ RenderOverlayMesh()

virtual void VerticesEngine.vxEntity3D.RenderOverlayMesh ( vxCamera3D Camera )

virtual

Renders the overlay mesh.

Parameters

Camera Camera.

Reimplemented in VerticesEngine.Editor.Entities.vxEditorEntity, VerticesEngine.Editor.Entities.vxGizmo, VerticesEngine.Editor.Entities.vxGizmoHotKeyTranslationEntity, VerticesEngine.Editor.Entities.vxGizmoPanTranslationEntity, and VerticesEngine.Editor.Entities.vxResizingGizmoHandle.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ vxEntity3D() [1/4]

◆ vxEntity3D() [2/4]

◆ vxEntity3D() [3/4]

◆ vxEntity3D() [4/4]

Member Function Documentation

◆ CreateRenderer()

◆ InitShaders()

◆ OnDisposed()

◆ OnFirstUpdate()

◆ OnLoadModel()

◆ OnRefreshMaterialTextures()

◆ OnWorldTransformChanged()

◆ OverrideSelectionWithOtherEntity()

◆ RenderOverlayMesh()