Manipulator class. More...

#include <fbmanipulator.h>

Inheritance diagram for FBManipulator:

[legend]

Public Member Functions
	FBManipulator (const char *pName, HIObject pObject=NULL)
	Constructor. More...

virtual bool	FBCreate () override
	Open Reality Creation function. More...

void	PickRectStart (FBManipulatorPickType pType)
	Pick rectangle start. More...

void	PickRectMotion ()
	Pick rectangle motion. More...

void	PickRectStop ()
	Stop rectangle pick. More...

void	Pick (FBManipulatorPickType pType)
	Single pick. More...

int	PickGetCount ()
	Get number of items picked. More...

FBModel *	PickGetModel (int pIndex)
	Get model at index pIndex in list of picked items. More...

FBVertex	PickGetPoint (int pIndex)
	Get point at pIndex on pick path in 3D. More...

int	GetViewerWidth ()
	Get rendering area width. More...

int	GetViewerHeight ()
	Get rendering area height. More...

int	GetPanePosX ()
	Get sub-pane origin X offset from the viewer origin. More...

int	GetPanePosY ()
	Get sub-pane origin Y offset from the viewer origin. More...

int	GetPaneWidth ()
	Get sub-pane width. More...

int	GetPaneHeight ()
	Get sub-pane height. More...

void	FBModelRenderBegin (FBModel *pModel)
	Transform the current matrix to the reference of a given model. More...

void	FBModelRenderEnd ()
	End model matrix sequence. More...

virtual bool	ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
	Input function. More...

virtual void	ViewExpose ()
	Expose function. More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyBool	Active
	Read Write Property: Is manipulator active? More...

FBPropertyBool	AlwaysActive
	Read Write Property: Is manipulator always active? More...

FBPropertyBool	Visible
	Read Write Property: Is manipulator visible? More...

FBPropertyBool	DefaultBehavior
	Read Write Property: Using default manipulator behavior? More...

FBPropertyString	ViewerText
	Read Write Property: Text displayed in view. More...

FBPropertyCamera	CurrentCamera
	Read Only Property: Current camera. More...

FBPropertyBool	ConsumeEvent
	Read Write Property: Is manipulator consuming event? If true, this will prevent other manipulators from being called. More...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Manipulator class.

Definition at line 115 of file fbmanipulator.h.

Constructor & Destructor Documentation

◆ FBManipulator()

FBManipulator	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pName	Name of manipulator.
pObject	Internal parent object(default=NULL).

Member Function Documentation

◆ FBCreate()

virtual bool FBCreate ( )

overridevirtual

Open Reality Creation function.

Returns: Outcome of creation (true/false).

Reimplemented from FBComponent.

◆ FBModelRenderBegin()

void FBModelRenderBegin ( FBModel * pModel )

Transform the current matrix to the reference of a given model.

This call is used to move into Model space in order to draw with respect to the model specified by pModel.

Parameters

pModel Model now at transformation origin.

◆ FBModelRenderEnd()

void FBModelRenderEnd ( )

End model matrix sequence.

◆ GetPaneHeight()

int GetPaneHeight ( )

Get sub-pane height.

Returns: Sub-pane area height.

◆ GetPanePosX()

int GetPanePosX ( )

Get sub-pane origin X offset from the viewer origin.

Returns: Sub-pane X offset.

◆ GetPanePosY()

int GetPanePosY ( )

Get sub-pane origin Y offset from the viewer origin.

Returns: Sub-pane Y offset.

◆ GetPaneWidth()

int GetPaneWidth ( )

Get sub-pane width.

Returns: Sub-pane area width.

◆ GetViewerHeight()

int GetViewerHeight ( )

Get rendering area height.

Returns: Render area height.

◆ GetViewerWidth()

int GetViewerWidth ( )

Get rendering area width.

Returns: Render area width.

◆ Pick()

void Pick ( FBManipulatorPickType pType )

Single pick.

Parameters

pType Picking method.

◆ PickGetCount()

int PickGetCount ( )

Get number of items picked.

Returns: Number of items picked.

◆ PickGetModel()

FBModel* PickGetModel ( int pIndex )

Get model at index pIndex in list of picked items.

Parameters

pIndex Index to get item at.

Returns: Handle to model picked at pIndex in pick list.

◆ PickGetPoint()

FBVertex PickGetPoint ( int pIndex )

Get point at pIndex on pick path in 3D.

Parameters

pIndex Index of pick point to get.

Returns: 3D pick point on the surface of the object at pIndex along pick path.

◆ PickRectMotion()

void PickRectMotion ( )

Pick rectangle motion.

◆ PickRectStart()

void PickRectStart ( FBManipulatorPickType pType )

Pick rectangle start.

Parameters

pType Picking method.

◆ PickRectStop()

void PickRectStop ( )

Stop rectangle pick.

◆ ViewExpose()

virtual void ViewExpose ( )

virtual

Expose function.

Remarks: This function is called by the UI thread.

◆ ViewInput()

virtual bool ViewInput	(	int	pMouseX,
		int	pMouseY,
		FBInputType	pAction,
		int	pButtonKey,
		int	pModifier
	)

virtual

Input function.

Parameters

pMouseX	Mouse X position.
pMouseY	Mouse Y position.
pAction	Mouse action.
pButtonKey	Keyboard key pressed.
pModifier	Key modifier (CTRL, ALT, SHIFT)

Returns: true if successful.

Remarks: This function is called by the UI thread.

Member Data Documentation

◆ Active

FBPropertyBool Active

Read Write Property: Is manipulator active?

Definition at line 224 of file fbmanipulator.h.

◆ AlwaysActive

FBPropertyBool AlwaysActive

Read Write Property: Is manipulator always active?

Definition at line 225 of file fbmanipulator.h.

◆ ConsumeEvent

FBPropertyBool ConsumeEvent

Read Write Property: Is manipulator consuming event? If true, this will prevent other manipulators from being called.

Definition at line 230 of file fbmanipulator.h.

◆ CurrentCamera

FBPropertyCamera CurrentCamera

Read Only Property: Current camera.

Definition at line 229 of file fbmanipulator.h.

◆ DefaultBehavior

FBPropertyBool DefaultBehavior

Read Write Property: Using default manipulator behavior?

Definition at line 227 of file fbmanipulator.h.

◆ ViewerText

FBPropertyString ViewerText

Read Write Property: Text displayed in view.

Definition at line 228 of file fbmanipulator.h.

◆ Visible

FBPropertyBool Visible

Read Write Property: Is manipulator visible?

Definition at line 226 of file fbmanipulator.h.

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

fbmanipulator.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBManipulator()

Member Function Documentation

◆ FBCreate()

◆ FBModelRenderBegin()

◆ FBModelRenderEnd()

◆ GetPaneHeight()

◆ GetPanePosX()

◆ GetPanePosY()

◆ GetPaneWidth()

◆ GetViewerHeight()

◆ GetViewerWidth()

◆ Pick()

◆ PickGetCount()

◆ PickGetModel()

◆ PickGetPoint()

◆ PickRectMotion()

◆ PickRectStart()

◆ PickRectStop()

◆ ViewExpose()

◆ ViewInput()

Member Data Documentation

◆ Active

◆ AlwaysActive

◆ ConsumeEvent

◆ CurrentCamera

◆ DefaultBehavior

◆ ViewerText

◆ Visible