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

Macros
#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 (K_DLLIMPORT, CommandState)
	FB_DEFINE_ENUM (K_DLLIMPORT, TimeReferential)
	FB_DEFINE_COMPONENT (K_DLLIMPORT, Command)

Detailed Description

Declaration for the FBCommand class.

Definition in file fbcommand.h.

Macro Definition Documentation

FBCommandDeclare

#define FBCommandDeclare	(		ClassName,
			Parent
	)

Value:

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

Command class declaration.

Parameters

ClassName	Command class name.
Parent	Parent class.

Definition at line 90 of file fbcommand.h.

FBCommandImplementation

#define FBCommandImplementation

(

ThisComponent

)

FBClassImplementation( ThisComponent )

Command class implementation.

Parameters

ThisComponent

Class to implement.

Definition at line 99 of file fbcommand.h.

FBRegisterCommand

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

Value:

    HIObject RegisterCommand##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
        ClassName *Class = new ClassName( Label ); \
        Class->mAllocated = true; \
        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.

FBSDK_DLL

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbcommand.h.

Enumeration Type Documentation

FBCommandState

enum FBCommandState

FBCommandState.

Enumerator
kFBCommandStateStandard	Standard.
kFBCommandStateMute	Mute.
kFBCommandStateSolo	Solo.
kFBCommandStateMuteBecauseSolo	Mute because of solo.

Definition at line 108 of file fbcommand.h.

FBTimeReferential

enum FBTimeReferential

FBCommandState.

Enumerator
kFBTimeReferentialAction	Action.
kFBTimeReferentialShot	Shot.
kFBTimeReferentialEdit	Edit.

Definition at line 116 of file fbcommand.h.