nw::lyt::Layout Class

Syntax

class Layout

Description

The class for managing the layout overall.

Member Functions

Memory Management
S GetAllocator Gets the current memory allocator.
S GetDeviceMemoryAllocator Gets the current memory allocator for device memory.
S SetAllocator Sets the memory allocator used to allocate memory blocks.
S SetDeviceMemoryAllocator Sets the memory allocator used to allocate memory blocks.
S AllocMemory Allocates a memory block.
S AllocDeviceMemory Allocates a memory block from device memory.
S FreeMemory Frees a memory block.
S FreeDeviceMemory Frees a memory block back to device memory.
Initialization
S SetLayoutDrawEnable Declares whether Layout::Draw is to be used (not recommended).
S GetLayoutDrawEnable Gets the setting indicating if Layout::Draw is to be used (not recommended).
V Build Initializes the layout based on the resource.
protected V BuildPaneObj Creates a pane from a resource.
Object Creation/Destruction
S NewObj Creates an object.
S DeleteObj Destroys an object.
Constructors and Destructors
Layout Constructor.
V ~Layout Destructor.
Animation
V CreateAnimTransform Creates an animation.
V DeleteAnimTransform This deletes animations.
V BindAnimation Binds animations.
V UnbindAnimation Clears a bound animation.
V UnbindAllAnimation Clears all the association between animations and panes.
V BindAnimationAuto Creates and binds animations at one time.
V SetAnimationEnable Sets the animation's enabled/disabled status.
V Animate Calculates animation results for all panes.
Rendering
V CalculateMtx Calculates the matrix for rendering.
V Draw Performs drawing (not recommended).
Set/Get
GetRootPane Gets the root pane.
GetGroupContainer Gets the group container.
GetLayoutSize Gets the display region size.
GetLayoutRect Gets the layout's display region.
V SetTagProcessor Sets the tag processor for all text box panes in the layout.
GetAnimTransformList Gets a list of animations bound to the layout.
protected SetRootPane Sets the root pane.
protected SetGroupContainer Sets the group container.
protected SetLayoutSize Sets the display region size.

See Also

Pane
AnimTransform

Revision History

2009/09/18
Initial version.

CONFIDENTIAL