fbcommand.h File Reference

Declaration for the FBCommand class. More...

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>

Go to the source code of this file.

Classes
class	FBCommand
	Command class. More...
Defines
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
#define	FBRegisterCommand(UniqueNameStr, ClassName, Label, Description, IconFilename)
	Command class registration.
#define	FBCommandDeclare(ClassName, Parent)
	Command class declaration.
#define	FBCommandImplementation(ThisComponent)   FBClassImplementation( ThisComponent )
	Command class implementation.
Enumerations
enum	FBCommandState { kFBCommandStateStandard, kFBCommandStateMute, kFBCommandStateSolo, kFBCommandStateMuteBecauseSolo }
	FBCommandState. More...
enum	FBTimeReferential { kFBTimeReferentialAction, kFBTimeReferentialShot, kFBTimeReferentialEdit }
	FBCommandState. More...
Functions
	__FB_FORWARD (FBCommand)
	FB_DEFINE_ENUM (FBSDK_DLL, CommandState)
	FB_DEFINE_ENUM (FBSDK_DLL, TimeReferential)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Command)

---

Detailed Description

Declaration for the FBCommand class.

Definition in file fbcommand.h.

---

Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Search for all occurrences

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbcommand.h.

#define FBRegisterCommand	(		UniqueNameStr,
			ClassName,
			Label,
			Description,
			IconFilename
	)

Search for all occurrences

Value:

HIObject RegisterCommand##ClassName( HIObject /*pOwner*/,char * pName,void * /*pData*/) \
    { \
        ClassName *Class = new ClassName( Label ); \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName##R1,"Commands",Label,Description,RegisterCommand##ClassName, true, IconFilename );                      \
        FBRegisterObject( ClassName##R2,"FbxStorable/Command",UniqueNameStr,Description,RegisterCommand##ClassName, true, IconFilename );   \
        FBRegisterObject( ClassName##R3,"Browsing/Templates/Commands",Label,Description,RegisterCommand##ClassName, true, "object_command.tif" );   \
    }   \

Command class registration.

Parameters:

UniqueNameStr	Unique name.
ClassName	Command class name.
Label	Short description.
Description	Long description.
IconFilename	Filename of associated icon.

Definition at line 67 of file fbcommand.h.

#define FBCommandDeclare	(		ClassName,
			Parent
	)

Search for all occurrences

Value:

FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(char * pName):Parent(pName) { FBClassInit; } \
  private:

Command class declaration.

Parameters:

ClassName	Command class name.
Parent	Parent class.

Definition at line 89 of file fbcommand.h.

#define FBCommandImplementation

(

ThisComponent

)

FBClassImplementation( ThisComponent )

Search for all occurrences

Command class implementation.

Parameters:

ThisComponent

Class to implement.

Definition at line 98 of file fbcommand.h.

---

Enumeration Type Documentation

enum FBCommandState

Search for all occurrences

FBCommandState.

Enumerator:

kFBCommandStateStandard	Standard. Search for all occurrences
kFBCommandStateMute	Mute. Search for all occurrences
kFBCommandStateSolo	Solo. Search for all occurrences
kFBCommandStateMuteBecauseSolo	Mute because of solo. Search for all occurrences

Definition at line 107 of file fbcommand.h.

                        {   
    kFBCommandStateStandard,            
    kFBCommandStateMute,                
    kFBCommandStateSolo,                
    kFBCommandStateMuteBecauseSolo      
};

enum FBTimeReferential

Search for all occurrences

FBCommandState.

Enumerator:

kFBTimeReferentialAction	Action. Search for all occurrences
kFBTimeReferentialShot	Shot. Search for all occurrences
kFBTimeReferentialEdit	Edit. Search for all occurrences

Definition at line 115 of file fbcommand.h.

                       {
    kFBTimeReferentialAction, 
    kFBTimeReferentialShot,
    kFBTimeReferentialEdit,
};

---

Function Documentation

__FB_FORWARD

(

FBCommand

)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		CommandState
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		TimeReferential
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Command
	)

Search for all occurrences