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.(Derived from Model.)
TraversalResults Definition of the bit flag indicating the traversal results.(Derived from SceneNode.)

typedef Definitions

Materials
MaterialRange Definition of a type that represents the range of a material list.(Derived from Model.)
Other
RenderSignal Definition of a callback slot that is called during rendering.(Derived from Model.)
RenderSlot Definition of a callback slot that is called during rendering.(Derived from Model.)
CalculateMatrixSignal Definition of a callback signal that is called during matrix calculation.(Derived from TransformNode.)
CalculateMatrixSlot Definition of a callback slot that is called during matrix calculation.(Derived from 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 const int Maximum number of children when a fixed amount of memory is used.(Derived from SceneObject.)
S DEFAULT_MAX_CALLBACKS const int Maximum number of callbacks when a fixed amount of memory is used.(Derived from SceneObject.)
S MAX_NAME_LENGTH const int Limit on names of scene objects.(Derived from SceneObject.)

Member Variables

NW_UT_RUNTIME_TYPEINFO
protected m_Children SceneNodeChildren Child nodes.(Derived from SceneNode.)
protected m_AnimBinding GfxPtr< AnimBinding > Animation binding.(Derived from SceneNode.)
protected m_BranchVisible bool Visibility of a branch and descendants.(Derived from SceneNode.)

Member Functions

Scene Trees
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.
V InheritTraversalResults Inherits transform 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.(Derived from Model.)
GetResMeshes Gets an array of mesh resources.(Derived from Model.)
GetResMeshNodeVisibilities Gets the MeshNodeVisibility resource at the specified index.(Derived from Model.)
GetResTransformNode Gets the transform node resource.(Derived from 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.)
Skeletons
GetSkeleton Gets a skeleton.
IsSharingSkeleton Returns true if sharing a skeleton with another model.
SwapSkeleton Swaps ownership of a skeleton.
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.
GetFullBakedAnimEnabled Gets a value indicating whether to use baked animation.
SetFullBakedAnimEnabled Sets a value indicating whether to use baked animation.
GetMaterialAnimGroup Gets a material animation group.(Derived from Model.)
GetMaterialAnimBindingIndex Gets the index among the animation bindings of a material animation group.(Derived from Model.)
GetMaterialAnimObject Gets a material animation object.(Derived from Model.)
SetMaterialAnimObject Configures a material animation object.(Derived from Model.)
GetVisibilityAnimGroup Gets a visibility animation group.(Derived from Model.)
GetVisibilityAnimBindingIndex Gets the animation binding index of a visibility animation group.(Derived from Model.)
GetVisibilityAnimObject Gets a visibility animation object.(Derived from Model.)
SetVisibilityAnimObject Sets a visibility animation object.(Derived 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.(Derived from Model.)
PostRenderSignal Gets the signal that is called after a model is rendered.(Derived from Model.)
PostCalculateWorldMatrixSignal Gets the signal after world matrix calculation.(Derived from TransformNode.)
PreUpdateSignal Gets the signal before the scene node is updated.(Derived from SceneNode.)
Materials
GetMaterials Gets the start and end of a material list.(Derived from Model.)
GetMaterialCount Gets the number of materials.(Derived from Model.)
GetMaterial Gets the material with the specified index number.(Derived from Model.)
GetMaterialActivator Gets the material activator.(Derived from Model.)
SetMaterialActivator Transfers ownership and sets the material activator. The material activator is also destroyed if the model class is destroyed.(Derived from Model.)
SetSharedMaterialActivator Sets the material activator without transferring ownership. Set here if the material activator is managed on the user side.(Derived from Model.)
Buffer Options
CheckBufferOption Checks the buffer option.(Derived from Model.)
GetBufferOption Gets the buffer option.(Derived from Model.)
Matrices
ModelViewMatrix Gets the modelview matrix.(Derived from Model.)
NormalMatrix Gets the normal matrix.(Derived from Model.)
UpdateModelViewMatrixAndNormalMatrix Updates the modelview matrix and the normal matrix.(Derived from Model.)
Layers
GetLayerId Gets the layer ID.(Derived from Model.)
SetLayerId Sets the layer ID.(Derived from Model.)
GetRenderLayerId Gets the render layer value of the mesh.(Derived from Model.)
Rendering
IsVisible Gets a flag indicating whether to render the model.(Derived from Model.)
SetVisible Sets a flag indicating whether to render the model.(Derived from Model.)
IsMeshVisible Gets a flag indicating whether to render the mesh.(Derived from Model.)
InvalidateRenderKeyCache Disables the key cache used for render sorting.(Derived from Model.)
User Parameters
GetUserParameter Gets user parameters.(Derived from Model.)
SetUserParameter Sets user parameters.(Derived from Model.)
Transforms
Transform Gets the transformation info.(Derived from TransformNode.)
WorldMatrix Gets the world matrix.(Derived from TransformNode.)
WorldTransform Gets the detailed transformation info after WorldMatrix calculation.(Derived from TransformNode.)
InverseWorldMatrix Gets the inverse matrix of the world matrix. Uses a cache the second time it is called and thereafter.(Derived from TransformNode.)
InvalidateInverseWorldMatrix Invalidates the cache used for the inverse matrix of the world matrix. (Call this when updating the world matrix.)(Derived from TransformNode.)
V UpdateDirection Updates the direction information.
V UpdateTransform Updates transform information.
SetResourceBasedTransform Sets a transform based on a resource's transform information.(Derived from TransformNode.)
SetResourceScaledTransform Sets a transform based on a resource's transform information.(Derived from TransformNode.)
Creation/Destruction
DestroyBranch Destroys all nodes on the current branch, including the current node.(Derived from SceneNode.)
S Create Generates a scene node.(Derived from SceneNode.)
S GetMemorySize Gets the memory size required at time of creation.(Derived from SceneNode.)
Destroy Destroys an object.(Derived from GfxObject.)
Traverses
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 the node and descendants.(Derived from SceneNode.)
IsBranchVisible Gets the flag used to render the node and descendants.(Derived from SceneNode.)
Constructors and Destructors
protected SkeletalModel Constructor.
protected V ~SkeletalModel Destructor.
Other
protected V Initialize Allocates memory for and initializes 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 direction inherited from parent node conversion information.(Derived from 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