Game entity. It usually aggregates multiple EntityComponent More...

Inheritance diagram for SiliconStudio.Paradox.EntityModel.Entity:

Classes
class	EntityDebugView

Public Member Functions
	Entity ()
	Create a new Entity instance. More...

	Entity (string name)
	Create a new Entity instance having the provided name. More...

	Entity (Vector3 position, string name=null)
	Create a new Entity instance having the provided name and initial position. More...

T	GetOrCreate< T > ()
	Gets or create a component with the specified key. More...

T	GetOrCreate< T > (PropertyKey< T > key)
	Gets or create a component with the specified key. More...

void	Add (EntityComponent component)
	Adds the specified component using the EntityComponent.DefaultKey. More...

T	Get< T > ()
	Gets a component by the specified key. More...

T	Get< T > (PropertyKey< T > key)
	Gets a component by the specified key. More...

void	Add< T > (PropertyKey< T > key, T value)
	Sets a component with the specified key. More...

void	Set< T > (PropertyKey< T > key, T value)
	Sets a component with the specified key. More...

override string	ToString ()

Public Member Functions inherited from SiliconStudio.Core.ComponentBase
void	Dispose ()

override string	ToString ()

Protected Attributes
TransformationComponent	transformation

Properties
TransformationComponent	Transformation `[get, set]`
	Gets or sets the Transformation associated to this entity. Added for convenience over usual Get/Set method. More...

Properties inherited from SiliconStudio.Core.ComponentBase
long	Id `[get, set]`

string	Name `[get, set]`
	Gets or sets the name of this component. More...

bool	IsDisposed `[get, set]`
	Has the component been disposed or not yet. More...

Properties inherited from SiliconStudio.Core.IComponent
long	Id `[get]`
	Gets the id of this component. More...

string	Name `[get]`
	Gets the name of this component. More...

Properties inherited from SiliconStudio.Core.IReferencable
int	ReferenceCount `[get]`
	Gets the reference count of this instance. More...

Properties inherited from SiliconStudio.Core.ICollectorHolder
ObjectCollector	Collector `[get]`
	Gets the collector. More...

Properties inherited from SiliconStudio.Core.IContentUrl
string	Url `[get, set]`
	The URL of this asset. More...

Additional Inherited Members
Public Attributes inherited from SiliconStudio.Core.ComponentBase
PropertyContainer	Tags
	Gets the attached properties to this component. More...

Protected Member Functions inherited from SiliconStudio.Core.ComponentBase
	ComponentBase ()
	Initializes a new instance of the ComponentBase class. More...

	ComponentBase (string name)
	Initializes a new instance of the ComponentBase class. More...

virtual void	OnNameChanged ()
	Called when Name property was changed. More...

virtual void	Destroy ()
	Disposes of object resources. More...

Detailed Description

Game entity. It usually aggregates multiple EntityComponent

Definition at line 28 of file Entity.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.EntityModel.Entity.Entity ( )

Create a new Entity instance.

Definition at line 41 of file Entity.cs.

SiliconStudio.Paradox.EntityModel.Entity.Entity ( string name )

Create a new Entity instance having the provided name.

Parameters

name	The name to give to the entity

Definition at line 50 of file Entity.cs.

SiliconStudio.Paradox.EntityModel.Entity.Entity	(	Vector3	position,
		string	name = `null`
	)

Create a new Entity instance having the provided name and initial position.

Parameters

position	The initial position of the entity
name	The name to give to the entity

Definition at line 60 of file Entity.cs.

Member Function Documentation

void SiliconStudio.Paradox.EntityModel.Entity.Add ( EntityComponent component )

Adds the specified component using the EntityComponent.DefaultKey.

Parameters

component The component.

Exceptions

System.ArgumentNullException component

Definition at line 125 of file Entity.cs.

Referenced by SiliconStudio.Paradox.Engine.AudioEmitterComponent.AttachSoundEffect().

void SiliconStudio.Paradox.EntityModel.Entity.Add< T >	(	PropertyKey< T >	key,
		T	value
	)

Sets a component with the specified key.

Template Parameters

T	Type of the component

Parameters

key	The key.
value	The value.

Exceptions

System.ArgumentNullException key

Type Constraints

T

:

EntityComponent

Definition at line 162 of file Entity.cs.

T SiliconStudio.Paradox.EntityModel.Entity.Get< T > ( )

Gets a component by the specified key.

Template Parameters

T	Type of the component

Returns: The component or null if does no exist

Exceptions

System.ArgumentNullException key

Type Constraints

T	:	EntityComponent
T	:	new()

Definition at line 137 of file Entity.cs.

T SiliconStudio.Paradox.EntityModel.Entity.Get< T > ( PropertyKey< T > key )

Gets a component by the specified key.

Template Parameters

T	Type of the component

Parameters

key The key.

Returns: The component or null if does no exist

Exceptions

System.ArgumentNullException key

Type Constraints

T

:

EntityComponent

Definition at line 149 of file Entity.cs.

T SiliconStudio.Paradox.EntityModel.Entity.GetOrCreate< T > ( )

Gets or create a component with the specified key.

Template Parameters

T	Type of the entity component

Returns: A new or existing instance of {T}

Type Constraints

T	:	EntityComponent
T	:	new()

Definition at line 89 of file Entity.cs.

T SiliconStudio.Paradox.EntityModel.Entity.GetOrCreate< T > ( PropertyKey< T > key )

Gets or create a component with the specified key.

Template Parameters

T	Type of the entity component

Parameters

key The key.

Returns: A new or existing instance of {T}

Type Constraints

T	:	EntityComponent
T	:	new()

Definition at line 108 of file Entity.cs.

void SiliconStudio.Paradox.EntityModel.Entity.Set< T >	(	PropertyKey< T >	key,
		T	value
	)

Sets a component with the specified key.

Template Parameters

T	Type of the component

Parameters

key	The key.
value	The value.

Exceptions

System.ArgumentNullException key

Type Constraints

T

:

EntityComponent

Definition at line 176 of file Entity.cs.

override string SiliconStudio.Paradox.EntityModel.Entity.ToString ( )

Definition at line 232 of file Entity.cs.

Member Data Documentation

TransformationComponent SiliconStudio.Paradox.EntityModel.Entity.transformation

protected

Definition at line 30 of file Entity.cs.

Property Documentation

TransformationComponent SiliconStudio.Paradox.EntityModel.Entity.Transformation

getset

Gets or sets the Transformation associated to this entity. Added for convenience over usual Get/Set method.

Definition at line 74 of file Entity.cs.

Referenced by SiliconStudio.Paradox.EntityModel.EntitySystem.Add(), SiliconStudio.Paradox.Engine.MeshProcessor.GenerateAssociatedData(), ScriptShader.Effects.ParticleProcessor.GenerateAssociatedData(), ScriptShader.Effects.LightProcessor.GenerateAssociatedData(), and ScriptTest.Script1.SetupFactory().

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

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/engine/SiliconStudio.Paradox.Engine/EntityModel/Entity.cs

Classes

Public Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation