Detailed Description

Used to build the user interface.

Layouts manage areas of the screen called regions. Regions contain UI components such as buttons, viewers, and edit boxes. Regions are added to layouts. When a UI component is bound to a region, the region defines how big it is and how it behaves when the layout is resized.

Types of Layouts

Device
Constraint
Manipulator
Shader

A region is first defined using the FBLayout.AddRegion() function. Once a region is defined and the corresponding UI component is created, and the component is bound to its region with FBLayout.SetControl(). You can use the FBSystem.OnUIIdle() in your layout to update real-time UI components such as guages and status indicators. In Python, FBBoxLayout and FBGridLayout take care of most of the region handling. They are used to create basic control layouts for simple tools. If you have a lot of content you can use FBScrollBox to manage it. For an example, see the Python sample Scrollbox.py.* Also see the Python sample Layout.py, and the C++ sample ortooluidemo.

Examples: UI/Attach.py, UI/Border.py, UI/Layout.py, ComplexTools/KeyboardMapper.py, ComplexTools/ShotTrackSetupTool.py

Inheritance diagram for FBLayout:

[legend]

List of all members.

Public Member Functions
bool	SetControl (str pName, HFBVisualComponent pComponent)
	Set control of a region to a visual component.
bool	SetControl (str pName, FBVisualComponent pComponent)
bool	SetView (str pName, HFBVisualComponent pComponent)
	Set view.
bool	SetView (str pName, FBVisualComponent pComponent)
	__init__ (object pObject=None)
	Constructor.
bool	AddRegion (str pName, str pTitle, int pX, FBAttachType pXType, str pXRelative, float pMultX, int pY, FBAttachType pYType, str pYRelative, float pMultY, int pW, FBAttachType pWType, str pWRelative, float pMultW, int pH, FBAttachType pHType, str pHRelative, float pMultH)
	Add a region to the layout.
bool	MoveRegion (str pName, int pX, int pY)
	Move a region.
bool	SizeRegion (str pName, int pW, int pH)
	Change a region's size.
bool	RemoveRegion (str pName)
	Remove a region.
bool	RenameRegion (str pOldName, str pNewName)
	Rename a region.
bool	GetRegion (str pName)
	Verify if a region with pName exists.
bool	GetRegionPositions (str pName, bool pComputed, int pX, int pY, int pW=None, int pH=None)
	Get region pName information (position and size).
	ClearControl (str pName)
	Remove a control from a region in a visual component.
FBVisualComponent	GetControl (str pName)
	Get control of a region in a visual component.
HIKtObject	GetHIKtObject (str pName)
	Set or Get internal toolkit: object.
bool	SetHIKtView (str pName, HIKtView pView)
	Set internal toolkit view.
HIKtView	GetHIKtView (str pName)
	Get internal toolkit view.
bool	SetBorder (str pName, FBBorderStyle pType, bool pShowTitle, bool pInSet, int pWidth, int pSpacing, float pMaxAngle, int pCornerRadius)
	Set border properties for a region.
bool	SetSplitStyle (str pName, FBSplitStyle pRegionType)
	Set a region's splitstyle.
FBSplitStyle	GetSplitStyle (str pName)
	Get a region's splitstyle.
bool	SetRegionTitle (str pName, str pTitle)
	Set a region's title.
	SetAutoRestructure (bool pAutoRestructure)
	Suspend all automatic layout recomputation.
	Restructure (bool pNoMove)
	Force a recomputation of all region placements in the layout.
	IObject_Declare (Implementation)
Public Attributes
FBPropertyEvent	OnInput
	Event: Input.
FBPropertyEvent	OnPaint
	Event: Paint layout.
FBPropertyEvent	OnIdle
	Event: Idle.
FBPropertyEvent	OnShow
	Event: Show layout.
FBPropertyEvent	OnResize
	Event: Resize layout.

Member Function Documentation

bool SetControl	(	str	pName,
		HFBVisualComponent	pComponent
	)

pName	Name of region to affect.
pComponent	Component to control region.

bool AddRegion	(	str	pName,
		str	pTitle,
		int	pX,
		FBAttachType	pXType,
		str	pXRelative,
		float	pMultX,
		int	pY,
		FBAttachType	pYType,
		str	pYRelative,
		float	pMultY,
		int	pW,
		FBAttachType	pWType,
		str	pWRelative,
		float	pMultW,
		int	pH,
		FBAttachType	pHType,
		str	pHRelative,
		float	pMultH
	)

pName	Name of region.
pTitle	Title to display.
pX	X: Position.
pXType	X: Type of attachment.
pXRelative	X: Item to attach to.
pMultX	X: Multiplier of relative value.
pY	Y: Position.
pYType	Y: Type of attachment.
pYRelative	Y: Item to attach to.
pMultY	Y: Multiplier of relative value.
pW	W: Width of region.
pWType	W: Type of attachment.
pWRelative	W: Item to attach to.
pMultW	W: Multiplier of relative value.
pH	H: Height of region.
pHType	H: Type of attachment.
pHRelative	H: Item to attach to.
pMultH	H: Multiplier of relative value.

pName	Name of region to move.
pX	New X position.
pY	New Y position.

pName	Name of region to resize.
pW	New region width.
pH	New region height.

bool GetRegionPositions	(	str	pName,
		bool	pComputed,
		int	pX,
		int	pY,
		int	pW = `None`,
		int	pH = `None`
	)

pName	Name of region.
pComputed	Is the information retrieved relative or absolute?

pX	Position in X of the region.
pY	Position in Y of the region.
pW	Width of the region.
pH	Height of the region.

bool SetBorder	(	str	pName,
		FBBorderStyle	pType,
		bool	pShowTitle,
		bool	pInSet,
		int	pWidth,
		int	pSpacing,
		float	pMaxAngle,
		int	pCornerRadius
	)

pName	Name of Region to change border properties.
pType	Border style to use.
pShowTitle	Show region title?
pInSet	Is region inset?
pWidth	Border width.
pSpacing	Border spacing.
pMaxAngle	Max angle for rounding.
pCornerRadius	Corner radius for rounding.

pOldName	Region's old name.
pNewName	Region's new name.

pName	Name of Region to set splitstyle.
pRegionType	Split style give to region.

pName	Name of region to change title.
pTitle	New title for region.

FBLayout Class Reference

Detailed Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation