Vertices Engine  v1.9.2.92
A Cross Platform game engine developed by Virtex Edge Design.
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Properties | Events | List of all members
VerticesEngine.vxGameObject Class Reference

This is the base class for all items in the Vertices Engine. It allows access to basic variables such as the Engine and the GraphicsDevice. More...

Inheritance diagram for VerticesEngine.vxGameObject:
VerticesEngine.vxISelectable VerticesEngine.Diagnostics.vxDebugUIControlBaseClass VerticesEngine.Graphics.vxRenderPass VerticesEngine.Graphics.vxRenderPipeline VerticesEngine.Particles.vxParticleSystemManager VerticesEngine.vxCameraManager VerticesEngine.vxEntity VerticesEngine.Diagnostics.vxDebugCommandUI VerticesEngine.Diagnostics.vxFpsCounterDebugControl VerticesEngine.Diagnostics.vxProfilerGraphDebugControl VerticesEngine.Diagnostics.vxSandboxCommandDebugControl VerticesEngine.Diagnostics.vxScreenConsoleDebugControl VerticesEngine.Diagnostics.vxSpriteBatchCountDebugControl VerticesEngine.Diagnostics.vxTimeRulerDebugControl VerticesEngine.Graphics.vxAntiAliasPostProcess VerticesEngine.Graphics.vxBlurEffectsPostProcess VerticesEngine.Graphics.vxCameraMotionBlurPostProcess VerticesEngine.Graphics.vxCascadeShadowRenderPass VerticesEngine.Graphics.vxDebugRenderPass VerticesEngine.Graphics.vxDistortionPostProcess VerticesEngine.Graphics.vxDistortionPostProcess2D VerticesEngine.Graphics.vxEdgeDetectPostProcess VerticesEngine.Graphics.vxFogPostProcess VerticesEngine.Graphics.vxGBufferRenderingPass VerticesEngine.Graphics.vxMainScene2DRenderPass VerticesEngine.Graphics.vxMainScene3DRenderPass VerticesEngine.Graphics.vxSceneBlurPostProcess VerticesEngine.Graphics.vxSceneLightRenderingPass VerticesEngine.Graphics.vxSelectedItemEdgePostProcess VerticesEngine.Graphics.vxSunLightPostProcess VerticesEngine.vxCamera VerticesEngine.vxEntity2D VerticesEngine.vxEntity3D

Public Member Functions

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

bool OnlySelectInSandbox = false
 

Static Public Attributes

static List< string > NameRegister = new List<string>()
 The name register.
 

Protected Member Functions

virtual void OnVisibilityChanged ()
 Called when an Objects Visibility Changes.
 
virtual bool HasId ()
 
virtual void OnSelectionStateChange ()
 Called when the selection state changes.
 
virtual string GetIdPrefix ()
 
virtual void OnDisposed ()
 Called when the entity is disposed.
 

Properties

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]
 

Events

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

This is the base class for all items in the Vertices Engine. It allows access to basic variables such as the Engine and the GraphicsDevice.

Constructor & Destructor Documentation

◆ vxGameObject()

VerticesEngine.vxGameObject.vxGameObject ( )

Creates a new vxGameObject.

Parameters
Engine

Member Function Documentation

◆ GetIcon()

virtual Texture2D VerticesEngine.vxGameObject.GetIcon ( int w,
int h )
virtual

Gets the icon for this game object. Override this to provide per-entity cusomtization.

Returns
The icon.

Implements VerticesEngine.vxISelectable.

◆ GetTitle()

virtual string VerticesEngine.vxGameObject.GetTitle ( )
virtual

Gets the title.

Returns
The title.

Implements VerticesEngine.vxISelectable.

◆ OnDisabled()

virtual void VerticesEngine.vxGameObject.OnDisabled ( )
virtual

Called on Component Disabled.

Reimplemented in VerticesEngine.Editor.Entities.vxGizmo.

◆ OnDisposed()

virtual void VerticesEngine.vxGameObject.OnDisposed ( )
protectedvirtual

Called when the entity is disposed.

Reimplemented in VerticesEngine.vxCamera, VerticesEngine.vxUtilCameraEntity, VerticesEngine.vxUtilCamera3D, VerticesEngine.Editor.Entities.vxEditorEntity, VerticesEngine.Editor.Entities.vxGizmo, VerticesEngine.Editor.Entities.vxGizmoTransformationBaseEntity, VerticesEngine.Particles.vxParticle2D, VerticesEngine.Particles.vxParticle3D, VerticesEngine.Particles.vxParticleSystemManager, VerticesEngine.Entities.vxSkyBox, VerticesEngine.Editor.Entities.vxBoundingVolume, VerticesEngine.vxEntity, VerticesEngine.vxEntity2D, VerticesEngine.vxEntity3D, VerticesEngine.vxWaterEntity, VerticesEngine.Graphics.vxBlurEffectsPostProcess, VerticesEngine.Graphics.vxDistortionPostProcess, VerticesEngine.Graphics.vxDistortionPostProcess2D, VerticesEngine.Graphics.vxEdgeDetectPostProcess, VerticesEngine.Graphics.vxFogPostProcess, VerticesEngine.Graphics.vxSceneBlurPostProcess, VerticesEngine.Graphics.vxSelectedItemEdgePostProcess, VerticesEngine.Graphics.vxSunLightPostProcess, VerticesEngine.Graphics.vxCascadeShadowRenderPass, VerticesEngine.Graphics.vxDebugRenderPass, VerticesEngine.Graphics.vxGBufferRenderingPass, VerticesEngine.Graphics.vxRenderPass, VerticesEngine.Graphics.Rendering.vxStaticMeshBatchEntity, and VerticesEngine.Graphics.vxRenderPipeline.

◆ OnEnabled()

virtual void VerticesEngine.vxGameObject.OnEnabled ( )
virtual

Called on Component Enabled.

Reimplemented in VerticesEngine.Editor.Entities.vxGizmo.

◆ OnGraphicsRefresh()

virtual void VerticesEngine.vxGameObject.OnGraphicsRefresh ( )
virtual

Called when there is a reset or refresh of Graphic settings such as resolution or setting.

Reimplemented in VerticesEngine.vxCamera, VerticesEngine.vxCamera2D, VerticesEngine.vxCameraManager, VerticesEngine.Graphics.vxBlurEffectsPostProcess, VerticesEngine.Graphics.vxCameraMotionBlurPostProcess, VerticesEngine.Graphics.vxDistortionPostProcess2D, VerticesEngine.Graphics.vxFogPostProcess, VerticesEngine.Graphics.vxSceneBlurPostProcess, VerticesEngine.Graphics.vxSelectedItemEdgePostProcess, VerticesEngine.Graphics.vxSunLightPostProcess, VerticesEngine.Graphics.vxCascadeShadowRenderPass, VerticesEngine.Graphics.vxDebugRenderPass, VerticesEngine.Graphics.vxGBufferRenderingPass, VerticesEngine.Graphics.vxMainScene3DRenderPass, VerticesEngine.Graphics.vxRenderPass, and VerticesEngine.Graphics.vxRenderPipeline.

◆ OnSelected()

virtual void VerticesEngine.vxGameObject.OnSelected ( )
virtual

Called when Selected.

Reimplemented in VerticesEngine.Editor.Entities.vxResizingGizmoHandle.

◆ OnVisibilityChanged()

virtual void VerticesEngine.vxGameObject.OnVisibilityChanged ( )
protectedvirtual

Called when an Objects Visibility Changes.

Reimplemented in VerticesEngine.vxEntity.

Property Documentation

◆ DefaultTexture

Texture2D VerticesEngine.vxGameObject.DefaultTexture
get

Gets the default texture.

The default texture.

◆ SelectionState

vxSelectionState VerticesEngine.vxGameObject.SelectionState
getset

Gets or sets the selection state.

The state of the selection.

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