nw::gfx::SkeletalModel Class

Syntax

class SkeletalModel : public nw::gfx::Model

Description

Model class that can contain a lightweight internal hierarchical structure.

Classes

nw::gfx::SkeletalModel::Builder Class for building skeletal models.

Structures

nw::gfx::SkeletalModel::Description Content to configure.

Enumerated Types

BufferOption Definitions of bit formats for buffer options.(Inherited from Model.
TraversalResults Definition of the bit flag indicating the traversal results.(Derived from SceneNode.

typedef Definitions

Material
MaterialRange Definition of a type that represents the range of a material list.(Inherited from Model.
Other
RenderSignal Definition of a callback slot that is called during rendering.(Inherited from Model.
RenderSlot Definition of a callback slot that is called during rendering.(Inherited from Model.
CalculateMatrixSignal Definition of a callback signal that is called during matrix calculation.(Derived TransformNode.
CalculateMatrixSlot Definition of a callback slot that is called during matrix calculation.(Derived TransformNode.
UpdateSignal Definition of a callback signal that is called during updates.(Derived from SceneNode.
UpdateSlot Definition of a callback slot that is called during updates.(Derived from SceneNode.

Member Constants

S DEFAULT_MAX_CHILDREN Maximum number of children when a fixed amount of memory is used.(Derived from SceneObject.
S DEFAULT_MAX_CALLBACKS Maximum number of callbacks when a fixed amount of memory is used.(Derived from SceneObject.
S MAX_NAME_LENGTH Limit on names of scene objects.(Derived from SceneObject.

Member Variables

NW_UT_RUNTIME_TYPEINFO
protected m_Children Child node.(Derived from SceneNode.
protected m_AnimBinding Animation binding.(Derived from SceneNode.

Member Functions

Scene Tree
V Accept Accepts visitors.
V TrackbackWorldMatrix Tracks back to the parent node and gets the world matrix.
V TrackbackWorldTransform Tracks back to the parent node and gets the world transform.
V TrackbackLocalTransform Tracks back to the parent node and gets the local transform.
NW_DEPRECATED_FUNCTION Inherits transform conversion information from the parent node.(Derived TransformNode.
V InheritTraversalResults Inherits transform conversion information from the parent node.
AttachChild Attaches a child.(Derived from SceneNode.
DetachChild Removes a child.(Derived from SceneNode.
GetChildBegin Gets the beginning of a child.(Derived from SceneNode.
GetChildEnd Gets the end of a child.(Derived from SceneNode.
DetachAllChildren Removes all children.(Derived from SceneNode.
Resources
GetResSkeletalModel Gets the skeletal model resource.
GetResModel Gets the model resource.(Inherited from Model.
GetResMeshes Gets an array of mesh resources.(Inherited from Model.
GetResMeshNodeVisibilities Gets the MeshNodeVisibility resource based on the index specified.(Inherited from Model.
GetResTransformNode Gets the transform node resource.(Derived TransformNode.
GetResSceneNode Gets the scene node resource.(Derived from SceneNode.
GetResSceneObject Gets the scene object resource.(Derived from SceneObject.
GetName Gets the name from the resource.(Derived from SceneObject.
Skeleton
GetSkeleton Gets a skeleton.
IsSharingSkeleton Returns true if sharing a skeleton with another model.
Animation
GetSkeletalAnimGroup Gets the skeletal animation group.
GetSkeletalAnimBindingIndex Gets the index among the animation bindings of a skeletal animation group.
GetSkeletalAnimObject Gets a skeletal animation object.
SetSkeletalAnimObject Sets a skeletal animation object.
GetMaterialAnimGroup Gets a material animation group.(Inherited from Model.
GetMaterialAnimBindingIndex Gets the index among the animation bindings of a material animation group.(Inherited from Model.
GetMaterialAnimObject Gets a material animation object.(Inherited from Model.
SetMaterialAnimObject Configures a material animation object.(Inherited from Model.
GetVisibilityAnimGroup Gets a visibility animation group.(Inherited from Model.
GetVisibilityAnimBindingIndex Gets the index among the animation bindings of a visibility animation group.(Inherited from Model.
GetVisibilityAnimObject Gets a visibility animation object.(Inherited from Model.
SetVisibilityAnimObject Sets a visibility animation object.(Inherited from Model.
GetAnimBinding Gets the animation binding.(Derived from SceneNode.
SetAnimBinding Sets the animation binding.(Derived from SceneNode.
UpdateFrame Updates the frames for all configured animation objects.(Derived from SceneNode.
Callbacks
PreRenderSignal Gets the signal that is called before a model is rendered.(Inherited from Model.
PostRenderSignal Gets the signal that is called after a model is rendered.(Inherited from Model.
PostCalculateWorldMatrixSignal Gets the signal after world matrix calculation.(Derived TransformNode.
PreUpdateSignal Gets the signal before the scene node is updated.(Derived from SceneNode.
Material
GetMaterials Gets the start and end of a material list.(Inherited from Model.
GetMaterialCount Gets the number of materials.(Inherited from Model.
GetMaterial Gets the material with the specified index number.(Inherited from Model.
GetMaterialActivator Gets the material activator.(Inherited from Model.
SetMaterialActivator Transfers ownership and sets the material activator. The material activator is also destroyed if the model class is destroyed.(Inherited from Model.
SetSharedMaterialActivator Sets the material activator without transferring ownership. Be sure to set here if the material activator is to be managed by the user.(Inherited from Model.
Buffer options
CheckBufferOption Checks the buffer option.(Inherited from Model.
GetBufferOption Gets the buffer option.(Inherited from Model.
Matrices
ModelViewMatrix Gets the modelview matrix.(Inherited from Model.
NormalMatrix Gets the normal matrix.(Inherited from Model.
UpdateModelViewMatrixAndNormalMatrix Updates the modelview matrix and the normal matrix.(Inherited from Model.
Layers
GetLayerId Gets the layer ID.(Inherited from Model.
SetLayerId Sets the layer ID.(Inherited from Model.
GetRenderLayerId Gets the render layer value of the mesh.(Inherited from Model.
Rendering
IsVisible Gets a flag indicating whether to render the model.(Inherited from Model.
SetVisible Sets a flag indicating whether to render the model.(Inherited from Model.
IsMeshVisible Gets a flag representing whether the mesh is to be drawn.(Inherited from Model.
InvalidateRenderKeyCache Disables the key cache used for render sort.(Inherited from Model.
User Parameters
GetUserParameter Gets user parameters.(Inherited from Model.
SetUserParameter Sets the user parameter.(Inherited from Model.
Transform
Transform Gets the transformation info.(Derived TransformNode.
WorldMatrix Gets the world matrix.(Derived TransformNode.
WorldTransform Gets the detailed transformation info after WorldMatrix calculation.(Derived TransformNode.
InverseWorldMatrix Gets the inverse matrix of the world matrix. Uses a cache the second time it is called and thereafter.(Derived TransformNode.
InvalidateInverseWorldMatrix Invalidates the cache used for the inverse matrix of the world matrix. Call this when updating the world matrix.)(Derived TransformNode.
V UpdateDirection Updates the direction information.
V UpdateTransform Updates conversion information.
Create/Destroy
DestroyBranch Destroys all nodes on the current branch, including the current node.(Derived from SceneNode.
S Create Generates a scene node.(Derived from SceneNode.
Destroy Destroys an object.(Derived from GfxObject.
S GetMemorySize Gets the memory size required at time of creation.(Inherited from Model.
Traverse
GetTraversalResults Gets the results of a traversal.(Derived from SceneNode.
SetTraversalResults Sets the results of a traversal.(Derived from SceneNode.
IsEnabledResults Gets a value indicating whether a given traversal result is enabled.(Derived from SceneNode.
EnableTraversalResults Enables the results of a traversal.(Derived from SceneNode.
DisableTraversalResults Disables the results of a traversal.(Derived from SceneNode.
ResetTraversalResults Copies the result of traversal from a node.(Derived from SceneNode.
CopyTraversalResults Copies the result of traversal from a node.(Derived from SceneNode.
SetBranchVisible Sets the flag used to render below the node.(Derived from SceneNode.
IsBranchVisible Gets the flag used to render below the node.(Derived from SceneNode.
Constructors and Destructors
protected SkeletalModel Constructor.
protected V ~SkeletalModel Destructor.
Other
protected V Initialize Allocates memory for and initialized members.
protected CreateSkeletalAnimGroup Creates an animation group for skeletal animation.
protected GetAnimTargetObject Gets a pointer to model data registered for the skeletal animation.
protected CalcInheritingDiretion Calculates the direction in which conversion information for parent nodes is inherited.(Derived TransformNode.
protected IsCircularReference Returns true if there is a circular reference.(Derived from SceneNode.
protected AcceptChildren Makes all nodes accept visitors.(Derived from SceneNode.

Class Hierarchy

nw::gfx::GfxObject
  nw::gfx::SceneObject
    nw::gfx::SceneNode
      nw::gfx::TransformNode
        nw::gfx::Model
          nw::gfx::SkeletalModel

CONFIDENTIAL