fbmanipulator.h File Reference

Create new manipulators using the FBManipulator class. More...

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

Go to the source code of this file.

Classes
class	FBManipulator
	Manipulator class. More...
class	FBPropertyListManipulator
	PropertyList: Manipulator. More...
class	FBManipulatorTransform
	Manipulator class. More...
Defines
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
#define	FBRegisterManipulator(ClassName, Label, Description, IconFilename)
	Manipulator class registration.
#define	FBManipulatorDeclare(ClassName, Parent)
	Manipulator class declaration.
#define	FBManipulatorImplementation(ThisComponent)   FBClassImplementation( ThisComponent )
	Manipulator class implementation.
Enumerations
enum	FBManipulatorPickType { FBPickObjects, FBPickPoints, FBPickSurfaces }
	Types of manipulator picking. More...
enum	FBManipulatorTransformType { kFBManipulatorTransformNone, kFBManipulatorTransformTranslation, kFBManipulatorTransformRotation, kFBManipulatorTransformScaling }
	Manipulator transform stles. More...
Functions
	FB_FORWARD (FBModel)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Manipulator)
	FB_DEFINE_COMPONENT (FBSDK_DLL, Camera)
	__FB_FORWARD (FBManipulator)
	FB_DEFINE_LIST (FBSDK_DLL, Manipulator)
	__FB_FORWARD (FBManipulatorTransform)
	FB_DEFINE_COMPONENT (FBSDK_DLL, ManipulatorTransform)
	FB_DEFINE_ENUM (FBSDK_DLL, ManipulatorTransformType)

---

Detailed Description

Create new manipulators using the FBManipulator class.

Definition in file fbmanipulator.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 fbmanipulator.h.

#define FBRegisterManipulator	(		ClassName,
			Label,
			Description,
			IconFilename
	)

Search for all occurrences

Value:

HIObject RegisterManipulator##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,"Manipulators",Label,Description,RegisterManipulator##ClassName,true, IconFilename );   \
    }

Manipulator class registration.

Parameters:

ClassName	Manipulator class name.
Label	Short description.
Description	Long description.
IconFilename	Filename of associated icon.

Definition at line 69 of file fbmanipulator.h.

#define FBManipulatorDeclare	(		ClassName,
			Parent
	)

Search for all occurrences

Value:

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

Manipulator class declaration.

Parameters:

ClassName	Manipulator class name.
Parent	Parent class.

Definition at line 89 of file fbmanipulator.h.

#define FBManipulatorImplementation

(

ThisComponent

)

FBClassImplementation( ThisComponent )

Search for all occurrences

Manipulator class implementation.

Parameters:

ThisComponent

Class to implement.

Definition at line 98 of file fbmanipulator.h.

---

Enumeration Type Documentation

enum FBManipulatorPickType

Search for all occurrences

Types of manipulator picking.

Enumerator:

FBPickObjects	Pick objects. Search for all occurrences
FBPickPoints	Pick points. Search for all occurrences
FBPickSurfaces	Pick surfaces. Search for all occurrences

Definition at line 105 of file fbmanipulator.h.

                                { 
    FBPickObjects,      
    FBPickPoints,       
    FBPickSurfaces      
};

enum FBManipulatorTransformType

Search for all occurrences

Manipulator transform stles.

Enumerator:

kFBManipulatorTransformNone	No manipulator. Search for all occurrences
kFBManipulatorTransformTranslation	Translation manipulator. Search for all occurrences
kFBManipulatorTransformRotation	Rotation manipulator. Search for all occurrences
kFBManipulatorTransformScaling	Scaling manipulator. Search for all occurrences

Definition at line 268 of file fbmanipulator.h.

                                { 
    kFBManipulatorTransformNone,        
    kFBManipulatorTransformTranslation, 
    kFBManipulatorTransformRotation,    
    kFBManipulatorTransformScaling      
};

---

Function Documentation

FB_FORWARD

(

FBModel

)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Manipulator
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Camera
	)

Search for all occurrences

__FB_FORWARD

(

FBManipulator

)

Search for all occurrences

FB_DEFINE_LIST	(	FBSDK_DLL	,
		Manipulator
	)

Search for all occurrences

__FB_FORWARD

(

FBManipulatorTransform

)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		ManipulatorTransform
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		ManipulatorTransformType
	)

Search for all occurrences