Public Member Functions | Public Attributes

FBManipulator Class Reference

This reference page is linked to from the following overview topics: Updated Objects, Motion Capture Devices.


Search for all occurrences

Detailed Description

Manipulator class.

Definition at line 114 of file fbmanipulator.h.

#include <fbmanipulator.h>

Inheritance diagram for FBManipulator:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBManipulator (const char *pName, HIObject pObject=NULL)
 Constructor.
virtual bool FBCreate ()
 Open Reality Creation function.
void PickRectStart (FBManipulatorPickType pType)
 Pick rectangle start.
void PickRectMotion ()
 Pick rectangle motion.
void PickRectStop ()
 Stop rectangle pick.
void Pick (FBManipulatorPickType pType)
 Single pick.
int PickGetCount ()
 Get number of items picked.
FBModelPickGetModel (int pIndex)
 Get model at index pIndex in list of picked items.
FBVertex PickGetPoint (int pIndex)
 Get point at pIndex on pick path in 3D.
int GetViewerWidth ()
 Get rendering area width.
int GetViewerHeight ()
 Get rendering area height.
int GetPanePosX ()
 Get sub-pane origin X offset from the viewer origin.
int GetPanePosY ()
 Get sub-pane origin Y offset from the viewer origin.
int GetPaneWidth ()
 Get sub-pane width.
int GetPaneHeight ()
 Get sub-pane height.
void FBModelRenderBegin (FBModel *pModel)
 Transform the current matrix to the reference of a given model.
void FBModelRenderEnd ()
 End model matrix sequence.
virtual bool ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
 Input function.
virtual void ViewExpose ()
 Expose function.

Public Attributes

FBPropertyBool Active
 Read Write Property: Is manipulator active?
FBPropertyBool AlwaysActive
 Read Write Property: Is manipulator always active?
FBPropertyBool Visible
 Read Write Property: Is manipulator visible?
FBPropertyBool DefaultBehavior
 Read Write Property: Using default manipulator behavior?
FBPropertyString ViewerText
 Read Write Property: Text displayed in view.
FBPropertyCamera CurrentCamera
 Read Only Property: Current camera.

Constructor & Destructor Documentation

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

Constructor.

Parameters:
pNameName of manipulator.
pObjectInternal parent object(default=NULL).

Member Function Documentation

virtual bool FBCreate ( ) [virtual]

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBComponent.

void PickRectStart ( FBManipulatorPickType  pType)

Pick rectangle start.

Parameters:
pTypePicking method.
void PickRectMotion ( )

Pick rectangle motion.

void PickRectStop ( )

Stop rectangle pick.

void Pick ( FBManipulatorPickType  pType)

Single pick.

Parameters:
pTypePicking method.
int PickGetCount ( )

Get number of items picked.

Returns:
Number of items picked.
FBModel* PickGetModel ( int  pIndex)

Get model at index pIndex in list of picked items.

Parameters:
pIndexIndex to get item at.
Returns:
Handle to model picked at pIndex in pick list.
FBVertex PickGetPoint ( int  pIndex)

Get point at pIndex on pick path in 3D.

Parameters:
pIndexIndex of pick point to get.
Returns:
3D pick point on the surface of the object at pIndex along pick path.
int GetViewerWidth ( )

Get rendering area width.

Returns:
Render area width.
int GetViewerHeight ( )

Get rendering area height.

Returns:
Render area height.
int GetPanePosX ( )

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

Returns:
Sub-pane X offset.
int GetPanePosY ( )

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

Returns:
Sub-pane Y offset.
int GetPaneWidth ( )

Get sub-pane width.

Returns:
Sub-pane area width.
int GetPaneHeight ( )

Get sub-pane height.

Returns:
Sub-pane area height.
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:
pModelModel now at transformation origin.
void FBModelRenderEnd ( )

End model matrix sequence.

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

Input function.

Parameters:
pMouseXMouse X position.
pMouseYMouse Y position.
pActionMouse action.
pButtonKeyKeyboard key pressed.
pModifierKey modifier (CTRL, ALT, SHIFT)
Returns:
true if successful.
Remarks:
This function is called by the UI thread.
virtual void ViewExpose ( ) [virtual]

Expose function.

Remarks:
This function is called by the UI thread.

Member Data Documentation

Read Write Property: Is manipulator active?

Definition at line 223 of file fbmanipulator.h.

Read Write Property: Is manipulator always active?

Definition at line 224 of file fbmanipulator.h.

Read Write Property: Is manipulator visible?

Definition at line 225 of file fbmanipulator.h.

Read Write Property: Using default manipulator behavior?

Definition at line 226 of file fbmanipulator.h.

Read Write Property: Text displayed in view.

Definition at line 227 of file fbmanipulator.h.

FBPropertyCamera CurrentCamera

Read Only Property: Current camera.

Definition at line 228 of file fbmanipulator.h.


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

FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator
FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator FBManipulator