VerticesEngine.Particles.vxParticle3D Class Reference

3D Particle Object for use in the vxParticleSystem3D Manager Class. More...

Inheritance diagram for VerticesEngine.Particles.vxParticle3D:

Public Member Functions
	vxParticle3D (vxGameplayScene3D scene, vxMesh model)
	Initializes a new instance of the VerticesEngine.Particles.vxParticle3D class.
vxIParticle	Spawn (vxGameObject emitter)
vxIParticle	Despawn ()
void	UpdateParticle ()
Public Member Functions inherited from VerticesEngine.vxEntity3D
	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
vxEnumParticleLayer	_particleLayer = vxEnumParticleLayer.Front
Public Attributes inherited from VerticesEngine.vxEntity3D
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
override bool	HasId ()
override vxEntityRenderer	CreateRenderer ()
override void	OnDisposed ()
	Disposes the Particle.
virtual void	OnParticleSpawned (vxGameObject emitter)
virtual void	OnParticleDespawned ()
Protected Member Functions inherited from VerticesEngine.vxEntity3D
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 ()
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	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 void	OnSelectionStateChange ()
	Called when the selection state changes.
virtual string	GetIdPrefix ()

Properties
bool	IsAlive [get, set]
	Boolean of whether to keep the Particle Alive or not.
vxEnumParticleLayer	ParticleLayer [get, set]
	Is the particle infront or behind the scene.
Properties inherited from VerticesEngine.vxEntity3D
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]
Properties inherited from VerticesEngine.Particles.vxIParticle

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

3D Particle Object for use in the vxParticleSystem3D Manager Class.

Constructor & Destructor Documentation

vxParticle3D()

VerticesEngine.Particles.vxParticle3D.vxParticle3D	(	vxGameplayScene3D	scene,
		vxMesh	model )

Initializes a new instance of the VerticesEngine.Particles.vxParticle3D class.

Parameters

Engine	The Vertices Engine Reference.
model	Model.
StartPosition	Start position.

Member Function Documentation

CreateRenderer()

override vxEntityRenderer VerticesEngine.Particles.vxParticle3D.CreateRenderer ( )

protectedvirtual

Reimplemented from VerticesEngine.vxEntity3D.

Despawn()

vxIParticle VerticesEngine.Particles.vxParticle3D.Despawn

(

)

Implements VerticesEngine.Particles.vxIParticle.

HasId()

override bool VerticesEngine.Particles.vxParticle3D.HasId ( )

protectedvirtual

Reimplemented from VerticesEngine.vxGameObject.

OnDisposed()

override void VerticesEngine.Particles.vxParticle3D.OnDisposed ( )

protectedvirtual

Disposes the Particle.

Reimplemented from VerticesEngine.vxEntity3D.

Spawn()

vxIParticle VerticesEngine.Particles.vxParticle3D.Spawn

(

vxGameObject

emitter

)

Implements VerticesEngine.Particles.vxIParticle.

UpdateParticle()

void VerticesEngine.Particles.vxParticle3D.UpdateParticle

(

)

Implements VerticesEngine.Particles.vxIParticle.

Property Documentation

IsAlive

bool VerticesEngine.Particles.vxParticle3D.IsAlive

getset

Boolean of whether to keep the Particle Alive or not.

Implements VerticesEngine.Particles.vxIParticle.

ParticleLayer

vxEnumParticleLayer VerticesEngine.Particles.vxParticle3D.ParticleLayer

getset

Is the particle infront or behind the scene.

Implements VerticesEngine.Particles.vxIParticle.

---

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

• /github/workspace/src/VerticesEngine/src.shared/Entities/Particles/vxParticle3D.cs