FBLayout Class Reference


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

  1. Device

  2. Constraint

  3. Manipulator

  4. 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:

List of all members.

Public Member Functions

bool SetControl (str pName, FBVisualComponent pComponent)
 Set control of a region to a visual component.
bool SetControl (str pName, FBVisualComponent pComponent)
bool SetView (str pName, FBVisualComponent 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 (K_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,
FBVisualComponent  pComponent 
)

Set control of a region to a visual component.

Parameters:
pNameName of region to affect.
pComponentComponent to control region.
Returns:
Operation was successful (true or false).
bool SetControl ( str  pName,
FBVisualComponent  pComponent 
)
bool SetView ( str  pName,
FBVisualComponent  pComponent 
)

Set view.

Parameters:
pNameName of Region.
pComponentComponent to set as view.
Returns:
Operation was successful (true or false).
bool SetView ( str  pName,
FBVisualComponent  pComponent 
)
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.

Parameters:
pNameName of region.
pTitleTitle to display.
pXX: Position.
pXTypeX: Type of attachment.
pXRelativeX: Item to attach to.
pMultXX: Multiplier of relative value.
pYY: Position.
pYTypeY: Type of attachment.
pYRelativeY: Item to attach to.
pMultYY: Multiplier of relative value.
pWW: Width of region.
pWTypeW: Type of attachment.
pWRelativeW: Item to attach to.
pMultWW: Multiplier of relative value.
pHH: Height of region.
pHTypeH: Type of attachment.
pHRelativeH: Item to attach to.
pMultHH: Multiplier of relative value.
Returns:
Operation was successful (true or false).
bool MoveRegion ( str  pName,
int  pX,
int  pY 
)

Move a region.

Parameters:
pNameName of region to move.
pXNew X position.
pYNew Y position.
Returns:
Operation was successful (true or false).
bool SizeRegion ( str  pName,
int  pW,
int  pH 
)

Change a region's size.

Parameters:
pNameName of region to resize.
pWNew region width.
pHNew region height.
Returns:
Operation was successful (true or false).
bool RemoveRegion ( str  pName)

Remove a region.

Parameters:
pNameName of region to remove.
Returns:
Operation was successful (true or false).
bool RenameRegion ( str  pOldName,
str  pNewName 
)

Rename a region.

Parameters:
pOldNameRegion's old name.
pNewNameRegion's new name.
Returns:
Operation was successful (true or false).
bool GetRegion ( str  pName)

Verify if a region with pName exists.

Parameters:
pNameName of region to check.
Returns:
Operation was successful (true or false).
bool GetRegionPositions ( str  pName,
bool  pComputed,
int  pX,
int  pY,
int  pW = None,
int  pH = None 
)

Get region pName information (position and size).

Parameters:
pNameName of region.
pComputedIs the information retrieved relative or absolute?
Return values:
pXPosition in X of the region.
pYPosition in Y of the region.
pWWidth of the region.
pHHeight of the region.
Returns:
Operation was successful (true or false).
ClearControl ( str  pName)

Remove a control from a region in a visual component.

Parameters:
pNameName of region to remove control.
FBVisualComponent GetControl ( str  pName)

Get control of a region in a visual component.

Parameters:
pNameName of region to find.
Returns:
The component if it is found.
HIKtObject GetHIKtObject ( str  pName)

Set or Get internal toolkit: object.

Parameters:
pNameName of region.
Returns:
Handle to internal toolkit object.
bool SetHIKtView ( str  pName,
HIKtView  pView 
)

Set internal toolkit view.

Parameters:
pNameName of region.
pViewView to set as view for region.
Returns:
Operation was successful (true or false).
HIKtView GetHIKtView ( str  pName)

Get internal toolkit view.

Parameters:
pNameName of region.
Returns:
Handle to internal toolkit view object.
bool SetBorder ( str  pName,
FBBorderStyle  pType,
bool  pShowTitle,
bool  pInSet,
int  pWidth,
int  pSpacing,
float  pMaxAngle,
int  pCornerRadius 
)

Set border properties for a region.

Parameters:
pNameName of Region to change border properties.
pTypeBorder style to use.
pShowTitleShow region title?
pInSetIs region inset?
pWidthBorder width.
pSpacingBorder spacing.
pMaxAngleMax angle for rounding.
pCornerRadiusCorner radius for rounding.
Returns:
Operation was successful (true or false).
bool SetSplitStyle ( str  pName,
FBSplitStyle  pRegionType 
)

Set a region's splitstyle.

Parameters:
pNameName of Region to set splitstyle.
pRegionTypeSplit style give to region.
Returns:
Operation was successful (true or false).
FBSplitStyle GetSplitStyle ( str  pName)

Get a region's splitstyle.

Parameters:
pNameName of Region to get splitstyle from.
Returns:
Split style of specified region.
bool SetRegionTitle ( str  pName,
str  pTitle 
)

Set a region's title.

Parameters:
pNameName of region to change title.
pTitleNew title for region.
Returns:
Operation was successful (true or false).
SetAutoRestructure ( bool  pAutoRestructure)

Suspend all automatic layout recomputation.

Parameters:
pAutoRestructureIf true, Suspend all automatic layout recomputation, else restore it.
Restructure ( bool  pNoMove)

Force a recomputation of all region placements in the layout.

IObject_Declare ( K_IMPLEMENTATION  )

Member Data Documentation

FBPropertyEvent OnInput
FBPropertyEvent OnPaint

Event: Paint layout.

FBPropertyEvent OnIdle
FBPropertyEvent OnShow

Event: Show layout.

FBPropertyEvent OnResize

Event: Resize layout.


FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout
FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout FBLayout