Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Core.ComponentBase Class Reference

Base class for a framework component. More...

Inheritance diagram for SiliconStudio.Core.ComponentBase:
SiliconStudio.Core.IComponent SiliconStudio.Core.ICollectorHolder SiliconStudio.Core.IReferencable SiliconStudio.Core.IReferencable SiliconStudio.Paradox.Audio.AudioEngine SiliconStudio.Paradox.Audio.SoundBase SiliconStudio.Paradox.Effects.Images.ImageEffectBase SiliconStudio.Paradox.Effects.Images.ImageEffectContext SiliconStudio.Paradox.Effects.RenderPass SiliconStudio.Paradox.EntityModel.Entity SiliconStudio.Paradox.Games.GameBase SiliconStudio.Paradox.Games.GameSystemBase SiliconStudio.Paradox.Games.GameWindow SiliconStudio.Paradox.Games.GraphicsDeviceManager SiliconStudio.Paradox.Graphics.BatchBase< TDrawInfo > SiliconStudio.Paradox.Graphics.BlendStateFactory SiliconStudio.Paradox.Graphics.Effect SiliconStudio.Paradox.Graphics.GeometricMeshData< T > SiliconStudio.Paradox.Graphics.GeometricPrimitive< T > SiliconStudio.Paradox.Graphics.GraphicsAdapter SiliconStudio.Paradox.Graphics.GraphicsDevice SiliconStudio.Paradox.Graphics.GraphicsFactory SiliconStudio.Paradox.Graphics.GraphicsOutput SiliconStudio.Paradox.Graphics.GraphicsPresenter SiliconStudio.Paradox.Graphics.GraphicsResourceBase SiliconStudio.Paradox.Graphics.GraphicsResourceFactoryBase SiliconStudio.Paradox.Graphics.PrimitiveQuad SiliconStudio.Paradox.Graphics.SpriteFont SiliconStudio.Paradox.ScriptContext

Public Member Functions

void Dispose ()
 
override string ToString ()
 

Public Attributes

PropertyContainer Tags
 Gets the attached properties to this component. More...
 

Protected Member Functions

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

Properties

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

Detailed Description

Base class for a framework component.

Definition at line 12 of file ComponentBase.cs.

Constructor & Destructor Documentation

SiliconStudio.Core.ComponentBase.ComponentBase ( )
protected

Initializes a new instance of the ComponentBase class.

Definition at line 22 of file ComponentBase.cs.

SiliconStudio.Core.ComponentBase.ComponentBase ( string  name)
protected

Initializes a new instance of the ComponentBase class.

Parameters
nameThe name attached to this component

Definition at line 31 of file ComponentBase.cs.

References SiliconStudio.Core.Diagnostics.ComponentTracker.Enable.

Member Function Documentation

void SiliconStudio.Core.ComponentBase.Dispose ( )

Definition at line 104 of file ComponentBase.cs.

References SiliconStudio.Core.Diagnostics.Destroy.

virtual void SiliconStudio.Core.ComponentBase.OnNameChanged ( )
protectedvirtual

Called when Name property was changed.

Definition at line 71 of file ComponentBase.cs.

override string SiliconStudio.Core.ComponentBase.ToString ( )

Definition at line 139 of file ComponentBase.cs.

Member Data Documentation

PropertyContainer SiliconStudio.Core.ComponentBase.Tags

Gets the attached properties to this component.

Definition at line 147 of file ComponentBase.cs.

Referenced by SiliconStudio.Paradox.Effects.Modules.Renderers.LightingGroupInfo.GetOrCreate().

Property Documentation

long SiliconStudio.Core.ComponentBase.Id
getset

Definition at line 42 of file ComponentBase.cs.

bool SiliconStudio.Core.ComponentBase.IsDisposed
getset

Has the component been disposed or not yet.

Definition at line 117 of file ComponentBase.cs.

Referenced by SiliconStudio.Paradox.Audio.SoundMusic.Load(), and SiliconStudio.Paradox.Audio.SoundEffect.Load().

string SiliconStudio.Core.ComponentBase.Name
getset

Gets or sets the name of this component.

The name.

Definition at line 54 of file ComponentBase.cs.

Referenced by SiliconStudio.Paradox.Effects.RenderSystem.Draw().


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