FBRenderer Class Reference

Open Reality renderer interface. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBRenderer:

Public Member Functions
	FBRenderer ()
	Constructor.
	ArrangeAllInSchematic (FBArrangeMode pMode)
	Request to arrange all objects in schematic view .
bool	ArrangeObjectsInSchematicFromModel (FBModel pModel)
	Request to arrange a node's tree in the Schematic View, given a starting node.
	ArrangeSelectedObjectsInSchematic ()
	Request to arrange selected objects in schematic view .
bool	CreateSchematicBookmark (str pBookmarkName)
	Create a new bookmark in the Schematic View.
bool	DeleteSchematicBookmark (str pBookmarkName)
	Delete a bookmark from the Schematic View.
bool	FrameCurrentCameraWithModels (bool pAll)
	Frame the camera or Schematic View in the current pane either with all models or with the currently selected models.
FBCamera	GetCameraInPane (unsigned int pPaneIndex)
	Return the camera displayed in the given pane index.
str	GetCurrentSchematicBookmarkName ()
	Return the current bookmark name used by the Schematic View.
FBModel	GetDisplayableGeometry (int pIndex)
	Get the displayable geometry model.
FBModelList	GetDisplayableGeometryInCameraFrustum (FBModelList pModelList=None, FBCamera pCamera=None)
	Get a list of displayable geometry inside given camera's frustum.
FBLight	GetDisplayableLight (int pIndex)
	Get the displayable light.
int	GetLastPickInfoList (FBPickInfosList pPickInfosList)
	Return the last picking info list in the current view pane.
unsigned int	GetPaneCount ()
	Return the number of panes displayed in the viewer's layout.
FBStringList	GetSchematicBookmarkNames ()
	Return the bookmark names available in the Schematic View.
bool	GetSchematicNodesBoundingBox (bool pConsiderCollapsedNodes, int pTop, int pLeft, int pBottom, int pRight)
	Returns the bounding box (top, left, bottom, right) used by all the Schematic View nodes.
bool	GetSchematicNodesBoundingBoxFromModel (FBModel pModel, bool pConsiderCollapsedNodes, int pTop, int pLeft, int pBottom, int pRight)
	Returns the bounding box (top, left, bottom, right) of a node's tree in the Schematic View, given a starting node.
int	GetSchematicViewPaneIndex ()
	Return the pane index of the pane displaying the Schematic View.
unsigned int	GetSelectedPaneIndex ()
	Return the pane index associated with the selected pane in the active viewer's layout.
FBViewingOptions	GetViewingOptions ()
	Obtain the current viewing options.
bool	IsCameraSwitcherInPane (unsigned int pPaneIndex)
	Return the Camera Switcher activeness in the given pane index.
bool	IsCurrentSchematicBookmarkDirty ()
	Return if the current bookmark used by the Schematic View is dirty or not.
bool	IsModelInsideCameraFrustum (FBModel pGeometry, FBCamera pCamera=None)
	To tell if given model is located inside camera's frustum.
	KeyboardInput (FBDeviceKeyboardKey pKeyIndex, bool pKeyState, bool pIsTrigger=False)
	Keyboard input.
bool	MouseInput (int pX, int pY, FBInputType pInputType, int pButtonKey, FBInputModifier pModifier, int pWheelDeltaValue=0, int pLayer=-1)
	Mouse input.
bool	MouseInputNormalized (float pX, float pY, FBInputType pInputType, int pButtonKey, FBInputModifier pModifier, int pWheelDeltaValue, int pLayer=-1, int pPaneId=-1)
	Mouse input.
	OGLModelDisplay (FBRenderOptions pRenderOptions, FBModel pModel)
	OGLSetupSceneLights (FBRenderOptions pRenderOptions)
	Setup the scene lights in OpenGL.
bool	Pick (int pX, int pY, FBPickInfosList pPickInfosList, bool pNeedIntersectPosition=False)
	Object picking selection.
bool	PickNormalized (float pX, float pY, FBPickInfosList pPickInfosList, bool pNeedIntersectPosition=False, int pPaneId=-1)
	Object picking selection.
bool	PreRender (int pLayer=-1)
	PreRenders one frame (needed for some shaders) This functions destroys the frame buffer content and must be called every time a render is called the typical order of call must be Renderer->Prerender // at this point the frame buffer is garbage -Clear the ogl -Do your render functions Renderer->Render.
bool	RectPick (int pX1, int pY1, int pX2, int pY2, FBPickInfosList pPickInfosList)
	Object rectangle selection.
bool	RectPickNormalized (float pX1, float pY1, float pX2, float pY2, FBPickInfosList pPickInfosList, int pPaneId=-1)
	Object rectangle selection.
bool	RenameSchematicBookmark (str pOldBookmarkName, str pNewBookmarkName)
	Rename a bookmark in the Schematic View.
bool	Render (int pLayer=-1)
	Renders one frame.
bool	RenderBegin (int pX, int pY, int pW, int pH)
	RenderBegin.
bool	RenderEnd (FBView pView=None)
	RenderEnd.
bool	SelectSchematicBookmark (str pBookmarkName)
	Select an existing bookmark in the Schematic View and use it as the current bookmark.
	SetCameraInPane (FBCamera pCamera, unsigned int pPaneIndex)
	Set the camera to display in the given pane index.
	SetCameraSwitcherInPane (unsigned int pPaneIndex, bool pActive)
	Set/Remove the Camera Switcher in the given pane index.
	SetPaneCount (unsigned int pPaneCount)
	Set the number of panes to display in the viewer's layout.
	SetSchematicViewInPane (unsigned int pPaneIndex, bool pActive)
	Set/Remove the Schematic View in the given pane index.
bool	SetSelectedPaneIndex (unsigned int pPaneIndex)
	Select the pane associated with the given pane index in the active viewer's layout.
bool	SetViewingOptions (FBViewingOptions pOptions)
	Set the viewing options.
	SetViewport (int pX, int pY, int pW, int pH)
	Must be called before inputing if the same renderer is used on multiple views/cameras in the same application.
bool	UpdateCurrentSchematicBookmark ()
	Update the current bookmark in the Schematic View.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
bool	AdvancedLightingMode
	Read write Property: Turn on/off advanced lighting setting UI widgets.
bool	AdvancedMaterialMode
	Read write Property: Turn on/off advanced material setting UI widgets.
bool	AutoEvaluate
	Read Write Property: Indicate if a call to RenderBegin will also cause a re-evaluation of the scene.
bool	Background
	Read Write Property: The renderer.
int	CurrentPaneCallbackIndex
	Read Write Property: Current Pane's Renderer Callback Index.
int	CurrentPaneCallbackPrefIndex
	Read Write Property: Current Pane's Renderer Callback Preference Index.
bool	DisplayNormals
	Read Write Property: Display model normals in main viewer.
int	DisplaySetUpdateId
	Read Only Property: Current DisplaySet Update Id. Add/Delete models, Show/Hide models will affect DisplaySet.
int	DisplayableGeometryCount
	Read Only Property: Displayable geometry count.
int	DisplayableLightCount
	Read Only Property: Displayable light count.
bool	FrustumCulling
	Read Write Property: Turn on/off the early frustum culling optimization.
bool	HideManipulatorsOnManip
	Read Write Property: Hide manipulators UI elements while manipulating.
bool	HideManipulatorsOnPlayback
	Read Write Property: Hide manipulators UI elements during playback.
bool	IDBufferDisplay
	Read write Property: Render Model's unique Color ID into color Buffer (used for picking)
bool	IDBufferPicking
	Read write Property: Use ID (Color) Buffer for picking, instead of OpenGl selection buffer picking.
float	IDBufferPickingAlpha
	Read write Property: Those Semi-transparent (Alpha Blend) geometry(region) contribute less than this threshold, will be considered as invisible during ID picking.
bool	PickingEnabled
	Read Write Property: Is picking in the viewer enabled?
int	RegisteredCallbackCount
	Read Only Property: Registered Renderer Callback Count.
FBListRendererCallback	RendererCallbacks
	List: Renderer Callbacks attached.
int	RendererUpdateId
	Read Only Property: Current Render Update Id. DisplaySet update, material change, texture changes and shader change and other operations will trigger Renderer update.
FBScene	Scene
	Read Write Property: Scene that the renderer will use/draw
bool	SelectionForceSnapPointsDisplay
	Read write Property: Force show all feature points (pivots and etc) on selected models if true, ignore individual model's settings.
bool	SelectionOverride
	Read write Property: Add transparent color override layer on selected models if true.
FBColor	SelectionOverrideColor
	Read write Property: Selection override layer color.
float	SelectionOverrideTransparency
	Read write Property: Selection override layer transparency.
bool	ShowStats
	Read Write Property: Show the stats about FPS, Evaluation rate ... like when using Shift-F in main viewer.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Open Reality renderer interface.

See samples: render.py, CameraSwitcher.py.

Constructor & Destructor Documentation

FBRenderer()

FBRenderer

(

)

Constructor.

Client code cannot instantiate objects of this class. The FBSystem and FBScene classes provide access to the current renderer.

Member Function Documentation

ArrangeAllInSchematic()

ArrangeAllInSchematic

(

FBArrangeMode

pMode

)

Request to arrange all objects in schematic view .

Parameters

pMode

Arrange mode.

ArrangeObjectsInSchematicFromModel()

bool ArrangeObjectsInSchematicFromModel

(

FBModel

pModel

)

Request to arrange a node's tree in the Schematic View, given a starting node.

Parameters

pModel

The starting node from which the arrange operation is requested.

Returns

True if the operation is successful, false otherwise.

ArrangeSelectedObjectsInSchematic()

ArrangeSelectedObjectsInSchematic

(

)

Request to arrange selected objects in schematic view .

CreateSchematicBookmark()

bool CreateSchematicBookmark

(

str

pBookmarkName

)

Create a new bookmark in the Schematic View.

Parameters

pBookmarkName

The new bookmark name.

Returns

True if the operation is successful, false otherwise. False is returned if the bookmark name is empty or if a bookmark with the given name already exists.

DeleteSchematicBookmark()

bool DeleteSchematicBookmark

(

str

pBookmarkName

)

Delete a bookmark from the Schematic View.

Parameters

pBookmarkName

The bookmark name to delete.

Returns

True if the operation is successful, false otherwise. False is returned if the bookmark name is empty or if no bookmark exists with the given name.

FrameCurrentCameraWithModels()

bool FrameCurrentCameraWithModels

(

bool

pAll

)

Frame the camera or Schematic View in the current pane either with all models or with the currently selected models.

Parameters

pAll	true to frame with all models.

Returns

true if successful.

GetCameraInPane()

FBCamera GetCameraInPane

(

unsigned int

pPaneIndex

)

Return the camera displayed in the given pane index.

If the Schematic View is displayed in the pane associated with the given pane index, the returned camera is the camera that would be displayed if the Schematic View was deactivated. If the Camera Switcher is on in the pane associated with the given pane index, the returned camera is the switcher's current camera.Note: To operate current camera in Camera Switcher, it is recommended to use FBCameraSwitcher().

Parameters

pPaneIndex

The pane index.

Returns

The camera used in the given pane index, NULL if the pane index is invalid.

GetCurrentSchematicBookmarkName()

str GetCurrentSchematicBookmarkName

(

)

Return the current bookmark name used by the Schematic View.

Returns

The current bookmark name used by the Schematic View. An empty string is returned if there is no current bookmark.

GetDisplayableGeometry()

FBModel GetDisplayableGeometry

(

int

pIndex

)

Get the displayable geometry model.

Those geometry models which have Show property ON are considered as "displayable".

Parameters

pIndex

displayable geometry model index to query.

Returns

displayable geometry model.

GetDisplayableGeometryInCameraFrustum()

FBModelList GetDisplayableGeometryInCameraFrustum	(	FBModelList	pModelList = None,
		FBCamera	pCamera = None
	)

Get a list of displayable geometry inside given camera's frustum.

This function will return conservative result. It's possible for some geometry outside of the frustum will be considered to be visible, but it will not skip any real visible geometry. This function should only be called in the main rendering thread.

Parameters

pModelList	ModelList holding the return models.
pCamera	use current camera if NULL.

Returns

Reference to pModelList. if pModelList is NULL return a const reference to internal static FBModelList and consecutive call to this function will invalidate the result of previous call.

GetDisplayableLight()

FBLight GetDisplayableLight

(

int

pIndex

)

Get the displayable light.

Those light models which have Show property ON are considered as "displayable".

Parameters

pIndex

displayable light index to query.

Returns

displayable light.

GetLastPickInfoList()

int GetLastPickInfoList

(

FBPickInfosList

pPickInfosList

)

Return the last picking info list in the current view pane.

Parameters

pPickInfosList

The list of pick infos.

Returns

number of item in the list.

GetPaneCount()

unsigned int GetPaneCount

(

)

Return the number of panes displayed in the viewer's layout.

Returns

The number of panes displayed.

GetSchematicBookmarkNames()

FBStringList GetSchematicBookmarkNames

(

)

Return the bookmark names available in the Schematic View.

Returns

A string list containing the bookmark names available in the Schematic View. An empty list is returned if no bookmark is available.

GetSchematicNodesBoundingBox()

bool GetSchematicNodesBoundingBox	(	bool	pConsiderCollapsedNodes,
		int	pTop,
		int	pLeft,
		int	pBottom,
		int	pRight
	)

Returns the bounding box (top, left, bottom, right) used by all the Schematic View nodes.

Parameters

pConsiderCollapsedNodes	True to also consider nodes which are not visible because collapsed, false otherwise.
pTop	Top value of the bounding box. Will be filled once the method returns.
pLeft	Left value of the bounding box. Will be filled once the method returns.
pBottom	Bottom value of the bounding box. Will be filled once the method returns.
pRight	Right value of the bounding box. Will be filled once the method returns.

Returns

True if the operation is successful, false otherwise (e.g. the Schematic View has any node in it, etc.).

GetSchematicNodesBoundingBoxFromModel()

bool GetSchematicNodesBoundingBoxFromModel	(	FBModel	pModel,
		bool	pConsiderCollapsedNodes,
		int	pTop,
		int	pLeft,
		int	pBottom,
		int	pRight
	)

Returns the bounding box (top, left, bottom, right) of a node's tree in the Schematic View, given a starting node.

Parameters

pModel	The starting node from which the bounding box tree is requested.
pConsiderCollapsedNodes	True to also consider nodes which are not visible because collapsed, false otherwise.
pTop	Top value of the bounding box. Will be filled once the method returns.
pLeft	Left value of the bounding box. Will be filled once the method returns.
pBottom	Bottom value of the bounding box. Will be filled once the method returns.
pRight	Right value of the bounding box. Will be filled once the method returns.

Returns

True if the operation is successful, false otherwise (e.g. the starting node is not in the Schematic View, etc.).

GetSchematicViewPaneIndex()

int GetSchematicViewPaneIndex

(

)

Return the pane index of the pane displaying the Schematic View.

Returns

The pane index of the pane displaying the Schematic View, -1 if the Schematic View is currently not displayed in any pane.

GetSelectedPaneIndex()

unsigned int GetSelectedPaneIndex

(

)

Return the pane index associated with the selected pane in the active viewer's layout.

Returns

The selected pane index.

GetViewingOptions()

FBViewingOptions GetViewingOptions

(

)

Obtain the current viewing options.

Returns

A structure that can be queried and updated for a call to SetViewingOptions.

IsCameraSwitcherInPane()

bool IsCameraSwitcherInPane

(

unsigned int

pPaneIndex

)

Return the Camera Switcher activeness in the given pane index.

If the Schematic View is displayed in the pane associated with the given pane index, the returned value is the value that would be returned if the Schematic View was deactivated.

Parameters

pPaneIndex

The pane index.

Returns

True if the Camera Switcher is active in the pane associated with the given pane index, False otherwise.

IsCurrentSchematicBookmarkDirty()

bool IsCurrentSchematicBookmarkDirty

(

)

Return if the current bookmark used by the Schematic View is dirty or not.

Returns

True if the current bookmark is dirty, false otherwise. False is returned if there is no current bookmark.

IsModelInsideCameraFrustum()

bool IsModelInsideCameraFrustum	(	FBModel	pGeometry,
		FBCamera	pCamera = None
	)

To tell if given model is located inside camera's frustum.

This function will return conservative result. It's possible for some geometry outside of the frustum will be considered to be visible, but it will not skip any real visible geometry. This function should only be called in the main rendering thread.

Parameters

pGeometry	the geometry to be queried.
pCamera	use current camera if NULL.

Returns

true if Model is inside camera frustum.

KeyboardInput()

KeyboardInput	(	FBDeviceKeyboardKey	pKeyIndex,
		bool	pKeyState,
		bool	pIsTrigger = False
	)

Keyboard input.

Parameters

pKeyIndex	Key index. (See "enum FBDeviceKeyboardKey" above for supported keys)
pKeyState	Key state. (True == key is down, False == key is up)
pIsTrigger	When setting pKeyState to True, resets key state to False right after operation.

MouseInput()

bool MouseInput	(	int	pX,
		int	pY,
		FBInputType	pInputType,
		int	pButtonKey,
		FBInputModifier	pModifier,
		int	pWheelDeltaValue = 0,
		int	pLayer = -1
	)

Mouse input.

Parameters

pX	X position.
pY	Y position.
pInputType	Type of input.
pButtonKey	Button/Key pressed.
pModifier	Modifier pressed (CTRL/ALT/SHIFT).
pWheelDeltaValue	Mouse wheel delta value
pLayer	Rendering layer ID(default=-1).

Returns

true if successful.

MouseInputNormalized()

bool MouseInputNormalized	(	float	pX,
		float	pY,
		FBInputType	pInputType,
		int	pButtonKey,
		FBInputModifier	pModifier,
		int	pWheelDeltaValue,
		int	pLayer = -1,
		int	pPaneId = -1
	)

Mouse input.

Parameters

pX	X position, normalized to the range of [0, 1] in the view port dimension.
pY	Y position, normalized to the range of [0, 1] in the view port dimension.
pInputType	Type of input.
pButtonKey	Button/Key pressed.
pModifier	Modifier pressed (CTRL/ALT/SHIFT).
pWheelDeltaValue	Mouse wheel delta value
pLayer	Rendering layer ID(default=-1).
pPaneId	specify which pane's dimension used for normalization, default (-1) for the whole viewer.

Returns

true if successful.

OGLModelDisplay()

OGLModelDisplay	(	FBRenderOptions	pRenderOptions,
		FBModel	pModel
	)

OGLSetupSceneLights()

OGLSetupSceneLights

(

FBRenderOptions

pRenderOptions

)

Setup the scene lights in OpenGL.

Parameters

pRenderOptions

See FBRenderOptions for more detail.

Pick()

bool Pick	(	int	pX,
		int	pY,
		FBPickInfosList	pPickInfosList,
		bool	pNeedIntersectPosition = False
	)

Object picking selection.

Parameters

pX	X position.
pY	Y position.
pPickInfosList	The list of pick infos.
pNeedIntersectPosition	require valid intersection position if true, this will take more time to process, and not reliable with very dense mesh.

PickNormalized()

bool PickNormalized	(	float	pX,
		float	pY,
		FBPickInfosList	pPickInfosList,
		bool	pNeedIntersectPosition = False,
		int	pPaneId = -1
	)

Object picking selection.

Parameters

pX	X position, normalized to the range of [0, 1] in the view port dimension.
pY	Y position, normalized to the range of [0, 1] in the view port dimension.
pPickInfosList	The list of pick infos.
pNeedIntersectPosition	require valid intersection position if true, this will take more time to process, and not reliable with very dense mesh.
pPaneId	specify which pane's dimension used for normalization, default (-1) for the whole viewer.

PreRender()

bool PreRender

(

int

pLayer = -1

)

PreRenders one frame (needed for some shaders) This functions destroys the frame buffer content and must be called every time a render is called the typical order of call must be Renderer->Prerender // at this point the frame buffer is garbage -Clear the ogl -Do your render functions Renderer->Render.

Parameters

pLayer

Rendering layer ID(default=-1).

Returns

true if successful.

RectPick()

bool RectPick	(	int	pX1,
		int	pY1,
		int	pX2,
		int	pY2,
		FBPickInfosList	pPickInfosList
	)

Object rectangle selection.

Parameters

pX1	Left upper corner X position.
pY1	Left upper corner y position.
pX2	Right bottom corner X position.
pY2	Right bottom corner y position.
pPickInfosList	The list of pick infos.

RectPickNormalized()

bool RectPickNormalized	(	float	pX1,
		float	pY1,
		float	pX2,
		float	pY2,
		FBPickInfosList	pPickInfosList,
		int	pPaneId = -1
	)

Object rectangle selection.

Parameters

pX1	Left upper corner X position, normalized to the range of [0, 1] in the viewport dimension.
pY1	Left upper corner y position, normalized to the range of [0, 1] in the viewport dimension.
pX2	Right bottom corner X position, normalized to the range of [0, 1] in the viewport dimension.
pY2	Right bottom corner y position, normalized to the range of [0, 1] in the viewport dimension.
pPickInfosList	The list of pick infos.
pPaneId	specify which pane's dimension used for normalization, default (-1) for the whole viewer.

RenameSchematicBookmark()

bool RenameSchematicBookmark	(	str	pOldBookmarkName,
		str	pNewBookmarkName
	)

Rename a bookmark in the Schematic View.

Parameters

pOldBookmarkName	The bookmark name to rename.
pNewBookmarkName	The new bookmark name.

Returns

True if the operation is successful, false otherwise. False is returned if the old/new bookmark name is empty, if the old bookmark doesn't exist or if a bookmark with the new given name already exists.

Render()

bool Render

(

int

pLayer = -1

)

Renders one frame.

Parameters

pLayer

Rendering layer ID(default=-1).

Returns

true if successful.

RenderBegin()

bool RenderBegin	(	int	pX,
		int	pY,
		int	pW,
		int	pH
	)

RenderBegin.

must be called before rendering can happen

Parameters

pX	X position where to render.
pY	Y position where to render.
pW	Width of render area.
pH	Hight of render area.

RenderEnd()

bool RenderEnd

(

FBView

pView = None

)

RenderEnd.

Parameters

pView

If you want the renderer to draw artifacts, such as TimeCode, CameraLabel or SafeArea, you must provide the FBView on which the renderer draws on.

Remarks

Must be called at the end of rendering.

SelectSchematicBookmark()

bool SelectSchematicBookmark

(

str

pBookmarkName

)

Select an existing bookmark in the Schematic View and use it as the current bookmark.

Parameters

pBookmarkName

The bookmark name to select.

Returns

True if the operation is successful, false otherwise. False is returned if the bookmark name is empty or if no bookmark exists with the given name.

SetCameraInPane()

SetCameraInPane	(	FBCamera	pCamera,
		unsigned int	pPaneIndex
	)

Set the camera to display in the given pane index.

If the Schematic View is displayed in the pane associated with the given pane index, the camera will be displayed when the Schematic View will be deactivated from this pane.Note: If current pane uses Camera Switcher, it will be set to use Camera, rather than old behavior that still uses Camera Switcher and sets Camera to be Camera Switcher's current camera, which introduce a Zombie Camera Switcher problem. By using Camera, the problem is gone.Note: To operate current camera in Camera Switcher, it is recommended to use FBCameraSwitcher().

Parameters

pCamera	The camera to set.
pPaneIndex	The pane index.

SetCameraSwitcherInPane()

SetCameraSwitcherInPane	(	unsigned int	pPaneIndex,
		bool	pActive
	)

Set/Remove the Camera Switcher in the given pane index.

To specify which camera the Camera Switcher should be displaying, use the SetCameraInPane method. If the Schematic View is displayed in the pane associated with the given pane index, the camera switcher will be displayed (if activated) when the Schematic View will be deactivated from this pane.

Parameters

pPaneIndex	The pane index.
pActive	True to activate the Camera Switcher in the given pane, False to remove it.

SetPaneCount()

SetPaneCount

(

unsigned int

pPaneCount

)

Set the number of panes to display in the viewer's layout.

Parameters

pPaneCount

The number of panes to display.

SetSchematicViewInPane()

SetSchematicViewInPane	(	unsigned int	pPaneIndex,
		bool	pActive
	)

Set/Remove the Schematic View in the given pane index.

When activating the Schematic View in the pane, if the Schematic View is already activated in another pane, the Schematic View will be removed from latter before being activated into the new pane.

Parameters

pPaneIndex	The pane index.
pActive	True to activate the Schematic View in the given pane, False to remove it.

SetSelectedPaneIndex()

bool SetSelectedPaneIndex

(

unsigned int

pPaneIndex

)

Select the pane associated with the given pane index in the active viewer's layout.

Parameters

pPaneIndex

The pane index.

Returns

True if the operation is successful, False otherwise.

SetViewingOptions()

bool SetViewingOptions

(

FBViewingOptions

pOptions

)

Set the viewing options.

Parameters

pOptions

See FBViewingOptions for more detail.

SetViewport()

SetViewport	(	int	pX,
		int	pY,
		int	pW,
		int	pH
	)

Must be called before inputing if the same renderer is used on multiple views/cameras in the same application.

Parameters

pX	X position where to render.
pY	Y position where to render.
pW	Width of render area.
pH	Hight of render area.

UpdateCurrentSchematicBookmark()

bool UpdateCurrentSchematicBookmark

(

)

Update the current bookmark in the Schematic View.

Returns

True if the operation is successful, false otherwise. False is returned if there is no current bookmark.

Member Data Documentation

AdvancedLightingMode

bool AdvancedLightingMode

Read write Property: Turn on/off advanced lighting setting UI widgets.

AdvancedMaterialMode

bool AdvancedMaterialMode

Read write Property: Turn on/off advanced material setting UI widgets.

AutoEvaluate

bool AutoEvaluate

Read Write Property: Indicate if a call to RenderBegin will also cause a re-evaluation of the scene.

Background

bool Background

Read Write Property: The renderer.

CurrentPaneCallbackIndex

int CurrentPaneCallbackIndex

Read Write Property: Current Pane's Renderer Callback Index.

CurrentPaneCallbackPrefIndex

int CurrentPaneCallbackPrefIndex

Read Write Property: Current Pane's Renderer Callback Preference Index.

DisplayableGeometryCount

int DisplayableGeometryCount

Read Only Property: Displayable geometry count.

DisplayableLightCount

int DisplayableLightCount

Read Only Property: Displayable light count.

DisplayNormals

bool DisplayNormals

Read Write Property: Display model normals in main viewer.

DisplaySetUpdateId

int DisplaySetUpdateId

Read Only Property: Current DisplaySet Update Id. Add/Delete models, Show/Hide models will affect DisplaySet.

FrustumCulling

bool FrustumCulling

Read Write Property: Turn on/off the early frustum culling optimization.

HideManipulatorsOnManip

bool HideManipulatorsOnManip

Read Write Property: Hide manipulators UI elements while manipulating.

HideManipulatorsOnPlayback

bool HideManipulatorsOnPlayback

Read Write Property: Hide manipulators UI elements during playback.

IDBufferDisplay

bool IDBufferDisplay

Read write Property: Render Model's unique Color ID into color Buffer (used for picking)

IDBufferPicking

bool IDBufferPicking

Read write Property: Use ID (Color) Buffer for picking, instead of OpenGl selection buffer picking.

IDBufferPickingAlpha

float IDBufferPickingAlpha

Read write Property: Those Semi-transparent (Alpha Blend) geometry(region) contribute less than this threshold, will be considered as invisible during ID picking.

PickingEnabled

bool PickingEnabled

Read Write Property: Is picking in the viewer enabled?

RegisteredCallbackCount

int RegisteredCallbackCount

Read Only Property: Registered Renderer Callback Count.

RendererCallbacks

FBListRendererCallback RendererCallbacks

List: Renderer Callbacks attached.

RendererUpdateId

int RendererUpdateId

Read Only Property: Current Render Update Id. DisplaySet update, material change, texture changes and shader change and other operations will trigger Renderer update.

Scene

FBScene Scene

Read Write Property: Scene that the renderer will use/draw

SelectionForceSnapPointsDisplay

bool SelectionForceSnapPointsDisplay

Read write Property: Force show all feature points (pivots and etc) on selected models if true, ignore individual model's settings.

SelectionOverride

bool SelectionOverride

Read write Property: Add transparent color override layer on selected models if true.

SelectionOverrideColor

FBColor SelectionOverrideColor

Read write Property: Selection override layer color.

SelectionOverrideTransparency

float SelectionOverrideTransparency

Read write Property: Selection override layer transparency.

ShowStats

bool ShowStats

Read Write Property: Show the stats about FPS, Evaluation rate ... like when using Shift-F in main viewer.