FBManipulator Class Reference


Detailed Description

Manipulator class.

Inheritance diagram for FBManipulator:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
bool FBCreate ()
 Open Reality Creation function.
 PickRectStart (FBManipulatorPickType pType)
 Pick rectangle start.
 PickRectMotion ()
 Pick rectangle motion.
 PickRectStop ()
 Stop rectangle pick.
 Pick (FBManipulatorPickType pType)
 Single pick.
int PickGetCount ()
 Get number of items picked.
FBModel PickGetModel (int pIndex)
 Get model at index pIndex in list of picked items.
FBVector4 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.
 FBModelRenderBegin (FBModel pModel)
 Transform the current matrix to the reference of a given model.
 FBModelRenderEnd ()
 End model matrix sequence.
bool ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
 Input function.
 ViewExpose ()
 Expose function.

Public Attributes

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

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

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

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBComponent.

PickRectStart ( FBManipulatorPickType  pType)

Pick rectangle start.

Parameters:
pTypePicking method.
PickRectMotion ( )

Pick rectangle motion.

PickRectStop ( )

Stop rectangle pick.

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.
FBVector4 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.
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.
FBModelRenderEnd ( )

End model matrix sequence.

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

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.
ViewExpose ( )

Expose function.

Remarks:
This function is called by the UI thread.

Member Data Documentation

FBPropertyBase Active

Read Write Property: Is manipulator active?.

FBPropertyBase AlwaysActive

Read Write Property: Is manipulator always active?.

FBPropertyBase Visible

Read Write Property: Is manipulator visible?.

FBPropertyBase DefaultBehavior

Read Write Property: Using default manipulator behavior?.

Read Write Property: Text displayed in view.

FBPropertyCamera CurrentCamera

Read Only Property: Current camera.


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