fbcommand.h File Reference

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

File Description

Declaration for the FBCommand class.

Definition in file fbcommand.h.

Classes
class	FBCommand
	Command class. More...

Namespaces
	ORSDK2018

Macros
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once... More...
#define	FBRegisterCommand(UniqueNameStr, ClassName, Label, Description, IconFilename)
	Command class registration. More...
#define	FBCommandDeclare(ClassName, Parent )
	Command class declaration. More...
#define	FBCommandImplementation(ThisComponent)   FBClassImplementation( ThisComponent )
	Command class implementation. More...

Typedefs
typedef class FBPropertyBaseEnum< enum FBCommandState >	FBPropertyCommandState
typedef class FBPropertyBaseEnum< enum FBTimeReferential >	FBPropertyTimeReferential
typedef class FBPropertyBase< FBCommand *, kFBPT_object >	FBPropertyBaseCommand
typedef class FBPropertyBaseComponent< FBCommand * >	FBPropertyCommand

Enumerations
enum	FBCommandState { kFBCommandStateStandard, kFBCommandStateMute, kFBCommandStateSolo, kFBCommandStateMuteBecauseSolo }
	FBCommandState. More...
enum	FBTimeReferential { kFBTimeReferentialAction, kFBTimeReferentialShot, kFBTimeReferentialEdit }
	FBCommandState. More...

Macro Definition Documentation

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

Examples:

Definition at line 89 of file fbcommand.h.

#define FBCommandImplementation

(

ThisComponent

)

FBClassImplementation( ThisComponent )

Command class implementation.

Parameters

ThisComponent

Class to implement.

Examples:

Definition at line 98 of file fbcommand.h.

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

Value:

HIObject RegisterCommand##ClassName( HIObject /*pOwner*/,const 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.

Examples:

Definition at line 67 of file fbcommand.h.

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbcommand.h.

Go to the source code of this file.