Detailed Description

Open Reality renderer interface.

Examples: Samples/Camera/CameraSwitcher.py, Samples/Camera/StereoCameraDisplayMode.py, Rendering/render.py

Inheritance diagram for FBRenderer:

Public Member Functions
	__init__ (object pObject)
	Constructor.
	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	RenderBegin (int pX, int pY, int pW, int pH)
	RenderBegin.
bool	RenderEnd (HFBView pView=None)
	RenderEnd.
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	Render (int pLayer=-1)
	Renders one frame.
bool	SetViewingOptions (FBViewingOptions pOptions)
	Set the viewing options.
FBViewingOptions	GetViewingOptions ()
	Obtain the current viewing options.
bool	FrameCurrentCameraWithModels (bool pAll)
	Frame the current camera either with all models or with the currently selected models.
bool	MouseInput (int pX, int pY, FBInputType pInputType, int pButtonKey, FBInputModifier pModifier, int pLayer=-1)
	Mouse input.
bool	MouseInputNormalized (float pX, float pY, FBInputType pInputType, int pButtonKey, FBInputModifier pModifier, int pLayer=-1, int pPaneId=-1)
	Mouse input.
bool	Pick (int pX, int pY, tuple pPickInfosList, bool pNeedIntersectPosition=False)
	Object picking selection.
bool	PickNormalized (float pX, float pY, tuple pPickInfosList, bool pNeedIntersectPosition=False, int pPaneId=-1)
	Object picking selection.
bool	RectPick (int pX1, int pY1, int pX2, int pY2, tuple pPickInfosList)
	Object rectangle selection.
bool	RectPickNormalized (float pX1, float pY1, float pX2, float pY2, tuple pPickInfosList, int pPaneId=-1)
	Object rectangle selection.
	KeyboardInput (FBDeviceKeyboardKey pKeyIndex, bool pKeyState, bool pIsTrigger=False)
	Keyboard input.
FBModel	GetDisplayableGeometry (int pIndex)
	Get the diplayable geometry model.
FBLight	GetDisplayableLight (int pIndex)
	Get the diplayable light.
tuple	GetDisplayableGeometryInCameraFrustum (tuple pModelList=None, FBCamera pCamera=None)
	Get a list of displayable geometry inside given camera's frustum.
bool	IsModelInsideCameraFrustum (FBModel pGeometry, FBCamera pCamera=None)
	To tell if given model is located inside camera's frustum.
Public Attributes
FBPropertyCamera	CurrentCamera
	Read Write Property: Current camera.
FBPropertyBase	UseCameraSwitcher
	Read Write Property: Activate/Deactivate usage of camera switcher for the first model view of main viewer.
FBPropertyManipulatorTransform	ManipulatorTransform
	Read Only Property: Manipulator responsible of moving objects.
FBPropertyListManipulator	Manipulators
	List: of manipulators.
FBPropertyScene	Scene
	Read Write Property: Scene that the renderer will use/draw.
FBPropertyBase	AutoEvaluate
	Read Write Property: Indicate if a call to RenderBegin will also cause a re-evaluation of the scene.
FBPropertyBase	Background
	Read Write Property: The renderer.
FBPropertyBase	ShowStats
	Read Write Property: Show the stats about FPS, Evaluation rate ...
FBPropertyBase	FrustumCulling
	Read Write Property: Turn on/off the early frustum culling optimization.
FBPropertyBase	DisplayNormals
	Read Write Property: Display model normals in main viewer.
FBPropertyBase	IDBufferPicking
	Read write Property: Use ID (Color) Buffer for picking, instead of OpenGl selection buffer picking.
FBPropertyBase	IDBufferPickingAlpha
	Read write Property: Those Semi-transparent (Alpha Blend) geometry(region) contribute less than this threshold, will be considered as invisible during ID picking.
FBPropertyBase	IDBufferDisplay
	Read write Property: Render Model's unique Color ID into color Buffer (used for picking).
FBPropertyBase	SelectionOverride
	Read write Property: Add transparent color override layer on selected models if true.
FBPropertyBase	SelectionOverrideTransparency
	Read write Property: Selection override layer transparency.
FBPropertyBase	SelectionOverrideColor
	Read write Property: Selection override layer color.
FBPropertyBase	DisplaySetUpdateId
	Read Only Property: Current DisplaySet Update Id.
FBPropertyBase	RendererUpdateId
	Read Only Property: Current Render Update Id.
FBPropertyBase	DisplayableGeometryCount
	Read Only Property: Displyable geometry count.
FBPropertyBase	DisplayableLightCount
	Read Only Property: Displyable light count.
FBPropertyBase	AdvancedMaterialMode
	Read write Property: Turn on/off advanced material setting UI widgets.

Member Function Documentation

__init__ ( object pObject )

Search for all occurrences

Constructor.

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

Parameters:

pObject For internal use only.

Examples: Samples/Camera/CameraSwitcher.py, Samples/Camera/StereoCameraDisplayMode.py, Rendering/render.py

Reimplemented from FBComponent.

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

Search for all occurrences

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.

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

Search for all occurrences

RenderBegin.

Parameters:

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

must be called before rendering can happen

bool RenderEnd ( HFBView pView = None )

Search for all occurrences

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.

bool PreRender ( int pLayer = -1 )

Search for all occurrences

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.

bool Render ( int pLayer = -1 )

Search for all occurrences

Renders one frame.

Parameters:

pLayer Rendering layer ID(default=-1).

Returns:: true if successful.

bool SetViewingOptions ( FBViewingOptions pOptions )

Search for all occurrences

Set the viewing options.

Parameters:

pOptions See FBViewingOptions for more detail.

FBViewingOptions GetViewingOptions ( )

Search for all occurrences

Obtain the current viewing options.

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

bool FrameCurrentCameraWithModels ( bool pAll )

Search for all occurrences

Frame the current camera either with all models or with the currently selected models.

Parameters:

pAll	true to frame with all models.

Returns:: true if successful.

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

Search for all occurrences

Mouse input.

Parameters:

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

Returns:: true if successful.

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

Search for all occurrences

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

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

Search for all occurrences

Object picking selection.

Parameters:

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

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

Search for all occurrences

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 models hit, and the location of the hit.
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.

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

Search for all occurrences

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 models hit, and the location of the hit.

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

Search for all occurrences

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 models hit, and the location of the hit.
pPaneId	specify which pane's dimension used for normalization, default (-1) for the whole viewer.

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

Search for all occurrences

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.

FBModel GetDisplayableGeometry ( int pIndex )

Search for all occurrences

Get the diplayable 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.

FBLight GetDisplayableLight ( int pIndex )

Search for all occurrences

Get the diplayable light.

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

Parameters:

pIndex displayable light index to query.

Returns:: displayable light.

tuple GetDisplayableGeometryInCameraFrustum	(	tuple	pModelList = `None`,
		FBCamera	pCamera = `None`
	)

Search for all occurrences

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

This function will return conservative resuilt. 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.

bool IsModelInsideCameraFrustum	(	FBModel	pGeometry,
		FBCamera	pCamera = `None`
	)

Search for all occurrences

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

This function will return conservative resuilt. 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.

Member Data Documentation

FBPropertyCamera CurrentCamera

Search for all occurrences

Read Write Property: Current camera.

if UseCameraSwitcher is on, this will Get/Set camera switcher's current camera;

FBPropertyBase UseCameraSwitcher

Search for all occurrences

Read Write Property: Activate/Deactivate usage of camera switcher for the first model view of main viewer.

FBPropertyManipulatorTransform ManipulatorTransform

Search for all occurrences

Read Only Property: Manipulator responsible of moving objects.

FBPropertyListManipulator Manipulators

Search for all occurrences

List: of manipulators.

FBPropertyScene Scene

Search for all occurrences

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

FBPropertyBase AutoEvaluate

Search for all occurrences

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

FBPropertyBase Background

Search for all occurrences

Read Write Property: The renderer.

FBPropertyBase ShowStats

Search for all occurrences

Read Write Property: Show the stats about FPS, Evaluation rate ...

like when using Shift-F in main viewer.

FBPropertyBase FrustumCulling

Search for all occurrences

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

FBPropertyBase DisplayNormals

Search for all occurrences

Read Write Property: Display model normals in main viewer.

FBPropertyBase IDBufferPicking

Search for all occurrences

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

FBPropertyBase IDBufferPickingAlpha

Search for all occurrences

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

FBPropertyBase IDBufferDisplay

Search for all occurrences

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

FBPropertyBase SelectionOverride

Search for all occurrences

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

FBPropertyBase SelectionOverrideTransparency

Search for all occurrences

Read write Property: Selection override layer transparency.

FBPropertyBase SelectionOverrideColor

Search for all occurrences

Read write Property: Selection override layer color.