nw::lyt::Pane Class

Syntax

class Pane : public nw::lyt::internal::PaneBase

Description

The pane base class.

Member Variables

NW_UT_RUNTIME_TYPEINFO Runtime type information.

Member Functions

Constructors and Destructors
Pane Constructor.
V ~Pane Destructor.
Set/Get
GetName Gets the name of the pane.
SetName Sets the name of the pane.
GetUserData Gets the user information.
SetUserData Sets the user information.
IsInfluencedAlpha Determines whether changes to the parent alpha impact the child.
SetInfluencedAlpha Sets whether changes to the parent alpha value impact the child.
IsLocationAdjust Determines whether position adjustment processing is applied to the pane.
SetLocationAdjust Sets whether position adjustment processing is applied.
GetTranslate Gets the pane's display position.
SetTranslate Sets the pane's display position.
GetRotate Gets the pane's rotation.
SetRotate Sets the pane's rotation.
GetScale Gets the pane's scale ratio.
SetScale Sets the pane's scale ratio.
GetSize Gets the size of the pane.
SetSize Sets the size of the pane.
GetBasePositionH Gets the horizontal position specification for the pane standard position settings.
SetBasePositionH Sets the horizontal position specification for the pane standard position settings.
GetBasePositionV Gets the vertical position specification for the pane standard position settings.
SetBasePositionV Sets the vertical position specification for the pane standard position settings.
GetMtx Gets the pane's SRT matrix.
SetMtx Sets the pane's SRT matrix.
IsUserMtx Checks if the pane SRT matrix has been set by the user.
ResetMtx Cancels the SRT matrix settings.
GetGlobalMtx Gets the SRT matrix after calculation in the hierarchy.
SetGlobalMtx Sets the global matrix.
IsUserGlobalMtx Checks if the global matrix has been set by the user.
ResetGlobalMtx Cancels the global matrix settings.
GetPaneRect Gets a rectangle in the pane's local coordinates.
V GetVtxColor Gets the vertex color.
V SetVtxColor Sets the vertex color.
GetAlpha Gets the pane's alpha value.
SetAlpha Sets the pane's alpha value.
GetGlobalAlpha Gets the pane's global alpha value.
SetGlobalAlpha Sets the pane's global alpha value.
GetSRTElement Specifies an index to get a pane's SRT elements.
SetSRTElement Specifies an index to set a pane's SRT elements.
V GetColorElement Gets the pane's alpha value or vertex color components.
V SetColorElement Sets the pane's alpha value or vertex color components.
V GetVtxColorElement Gets the vertex color components.
V SetVtxColorElement Sets the vertex color components.
V GetMaterial Gets the pane's material.
V GetMaterialNum Gets the number of materials held by the pane.
GetExtUserDataNum Gets the amount of extended user data.
GetExtUserDataArray Gets the extended user data array.
FindExtUserDataByName Searches for extended user data by name.
Parent-Child Relationships
GetParent Gets the parent pane.
GetChildList Gets a list of child panes.
AppendChild Adds a pane to the end of the child pane list.
PrependChild Adds a pane to the start of the child pane list.
InsertChild Inserts a child pane at the specified position.
RemoveChild Removes a pane from the child pane list.
Search
V FindPaneByName Searches for panes by name.
V FindMaterialByName Searches for materials by name.
Animation
V Animate Calculates animation results for both self and for the children.
V AnimateSelf Calculates the animation result for self.
GetAnimationList Gets a list of bound animations.
V BindAnimation Binds animations.
V UnbindAnimation Clears a bound animation.
V UnbindAllAnimation Clears all bound animations.
V UnbindAnimationSelf Clears the window's animation links.
AddAnimationLink Adds animation link information.
V FindAnimationLinkSelf Searches for animation link information.
V SetAnimationEnable Sets the animation enable/disable state.
Rendering
IsVisible Determines whether a pane is displayed.
SetVisible Toggles pane display.
V CalculateMtx Calculates the matrix for rendering.
Other
IsUserAllocated Determines whether the user constructed the pane.
SetUserAllocated Declares that the pane was constructed by the user.
SetExtUserDataList Sets the extended user data list.
V Draw Draws its own pane and child panes.
V DrawSelf Performs the self-rendering process.
SetMtxDirty Requests SRT matrix recalculation.
protected V LoadMtx Calculates a model view matrix and sets it in GraphicsResource.
protected GetVtxPos Gets the pane's upper left coordinate.
protected GetMtxCondition Gets the local matrix status.
protected SetMtxCondition Sets the local matrix status.

Class Hierarchy

nw::lyt::internal::PaneBase
  nw::lyt::Pane

Revision History

2009/09/18
Initial version.

CONFIDENTIAL