Public Member Functions | Public Attributes

FBCommand Class Reference

Search for all occurrences

Detailed Description

Command class.

Definition at line 127 of file fbcommand.h.

#include <fbcommand.h>

Inheritance diagram for FBCommand:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  FBCommand (const char *pName=NULL, HIObject pObject=NULL)
  Constructor.
  IObject_Declare (Implementation)
virtual void  ExecuteNotify ()
  Execute the command.
virtual void  DragAndDropClearNotify ()
  Clear the command from the dropped items.
virtual void  DragAndDropAddNotify (FBComponent *pComponent)
  Add an item with drag and drop.
virtual void  RemoveNotify (HIObject pComponent)
  Remove an item that was added with drag and drop.
virtual bool  FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
  Storage/Retrieval of information into the FBX file format.
virtual bool  FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

Public Attributes

FBPropertyString  Description
  Property: Command description.
FBPropertyTime  StartTime
  Property: Start time for the command.
FBPropertyTime  StopTime
  Property: Stop time for the command.
FBPropertyCommandState  State
  Property: Current state of the command.
FBPropertyTimeReferential  TimeReferential
  Property: What is the time referential of the command?

Constructor & Destructor Documentation

FBCommand ( const char *  pName = NULL,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pName Name of Command (default is NULL).
pObject Internal parent object to own FBComponent (default is NULL).

Member Function Documentation

IObject_Declare ( Implementation  )
virtual bool FbxStore ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual]

Storage/Retrieval of information into the FBX file format.

Parameters:
pFbxObject Object to interface with FBX file format.
pStoreWhat Attributes to store in FBX file.
virtual bool FbxRetrieve ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual]
virtual void ExecuteNotify ( ) [virtual]

Execute the command.

virtual void DragAndDropClearNotify ( ) [virtual]

Clear the command from the dropped items.

virtual void DragAndDropAddNotify ( FBComponent pComponent ) [virtual]

Add an item with drag and drop.

Parameters:
pComponent Item to add.
virtual void RemoveNotify ( HIObject  pComponent ) [virtual]

Remove an item that was added with drag and drop.

Parameters:
pComponent Item to Remove.

Member Data Documentation

Property: Command description.

Definition at line 163 of file fbcommand.h.

Property: Start time for the command.

Definition at line 164 of file fbcommand.h.

Property: Stop time for the command.

Definition at line 165 of file fbcommand.h.

FBPropertyCommandState State

Property: Current state of the command.

Definition at line 166 of file fbcommand.h.

FBPropertyTimeReferential TimeReferential

Property: What is the time referential of the command?

Definition at line 167 of file fbcommand.h.


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

FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand
FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand FBCommand