C#Code
C#Code
Public Member Functions | Protected Attributes
Libraries._3D.ModelProperties.BaseModelProperty Class Reference
Inheritance diagram for Libraries._3D.ModelProperties.BaseModelProperty:
Libraries._3D.ModelProperties.AnimTextureProperty Libraries._3D.ModelProperties.AnimTextureProperty

List of all members.

Public Member Functions

 BaseModelProperty (string ID)
StringType GetID ()
bool IsFinished ()
abstract bool Update (int timePassed, object model)
 BaseModelProperty (string ID)
StringType GetID ()
bool IsFinished ()
abstract bool Update (int timePassed, object model)

Protected Attributes

bool m_update
 wether the property should be allowed to update. Value is true if it should, false if not.
bool m_isFinished
 wether the property has finished doing whatever it was doing (not all properties need this).
StringType m_ID
 ID that represents the property. If null then it is a unnamed property.

Detailed Description

Base class to derive model properties from. A model property is something that can be added to a model and that does something to the model. Model properties are things like scaling animations and uv animations. A property without a ID is a unnamed property. Once it is added to the model it can't be accessed directly since there is no way to reference it.


Constructor & Destructor Documentation

Libraries._3D.ModelProperties.BaseModelProperty.BaseModelProperty ( string  ID)

Constructor.

ID - ID to use for the property. Pass null to make it a unnamed property.
Libraries._3D.ModelProperties.BaseModelProperty.BaseModelProperty ( string  ID)

Constructor.

ID - ID to use for the property. Pass null to make it a unnamed property.

Member Function Documentation

StringType Libraries._3D.ModelProperties.BaseModelProperty.GetID ( )

Get the property ID.

Return:
Value is the ID of the property. It is null if it is a unnamed property.

StringType Libraries._3D.ModelProperties.BaseModelProperty.GetID ( )

Get the property ID.

Return:
Value is the ID of the property. It is null if it is a unnamed property.

bool Libraries._3D.ModelProperties.BaseModelProperty.IsFinished ( )

Get wether the property has finished.

Return:
Value is true if it is finished, false if not.

bool Libraries._3D.ModelProperties.BaseModelProperty.IsFinished ( )

Get wether the property has finished.

Return:
Value is true if it is finished, false if not.

abstract bool Libraries._3D.ModelProperties.BaseModelProperty.Update ( int  timePassed,
object  model 
) [pure virtual]

Handles updating the the property. Any effect it has on the model that owns it will be handled here.

timePassed - How much time has passed that the update should handle.
object - Model the property is in.

Value is true if the update was successful, false if not.

Implemented in Libraries._3D.ModelProperties.AnimTextureProperty, and Libraries._3D.ModelProperties.AnimTextureProperty.

abstract bool Libraries._3D.ModelProperties.BaseModelProperty.Update ( int  timePassed,
object  model 
) [pure virtual]

Handles updating the the property. Any effect it has on the model that owns it will be handled here.

timePassed - How much time has passed that the update should handle.
object - Model the property is in.

Value is true if the update was successful, false if not.

Implemented in Libraries._3D.ModelProperties.AnimTextureProperty, and Libraries._3D.ModelProperties.AnimTextureProperty.


Member Data Documentation

ID that represents the property. If null then it is a unnamed property.

wether the property has finished doing whatever it was doing (not all properties need this).

wether the property should be allowed to update. Value is true if it should, false if not.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties