Class TSceneNodeAnimatorFactory

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TSceneNodeAnimatorFactory = class(TReferenceCounted)

Description

Class for dynamic creation of scene node animators.

Hierarchy

Overview

Methods

Public function CreateAnimator(AType: TSceneNodeAnimatorType; Target: TSceneNode): TSceneNodeAnimator; overload; inline;
Public function CreateAnimator(const TypeName: AnsiString; Target: TSceneNode): TSceneNodeAnimator; overload; inline;
Public function GetTypeName(AType: TSceneNodeAnimatorType): AnsiString; inline;

Properties

Public property CreatableTypeCount: LongWord read GetCreatableTypeCount;
Public property CreatableTypeNames[Index: LongWord]: AnsiString read GetCreatableTypeName;
Public property CreatableTypes[Index: LongWord]: TSceneNodeAnimatorType read GetCreatableType;

Description

Methods

Public function CreateAnimator(AType: TSceneNodeAnimatorType; Target: TSceneNode): TSceneNodeAnimator; overload; inline;

Creates a scene node animator based on its type id. AType Type of the scene node animator to add. Target Target scene node of the new animator.

Returns

The new scene node animator or nil if not successful. You need to drop this pointer after calling this, see TReferenceCounted.Drop() for details.

Public function CreateAnimator(const TypeName: AnsiString; Target: TSceneNode): TSceneNodeAnimator; overload; inline;

Creates a scene node animator based on its type name.

Parameters
TypeName
Type of the scene node animator to add.
Target
Target scene node of the new animator.
Returns

The new scene node animator or nil if unsuccessful. You need to drop this pointer after calling this, see TReferenceCounted.Drop() for details.

Public function GetTypeName(AType: TSceneNodeAnimatorType): AnsiString; inline;

Returns the type name of a TSceneNodeAnimatorType.

Returns

The name if the given animator type is creatable, else ''.

Properties

Public property CreatableTypeCount: LongWord read GetCreatableTypeCount;
 
Public property CreatableTypeNames[Index: LongWord]: AnsiString read GetCreatableTypeName;

Holds the type names of all creatable scene animators.
The index must not exceed CreatableTypeCount-1.

Public property CreatableTypes[Index: LongWord]: TSceneNodeAnimatorType read GetCreatableType;

Holds the types of all creatable scene animators.
The index must not exceed CreatableTypeCount-1.


Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22