nw::gfx::Model Class

Syntax

class Model : public nw::gfx::TransformNode

Description

Class for representing objects that are displayed in a scene.

Structures

nw::gfx::Model::Description Content to configure.
nw::gfx::Model::IsVisibleModelDefaultFunctor Default function object for checking the model display flag.

Enumerated Types

BufferOption Definitions of bit formats for buffer options.
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.
Other
RenderSignal Definition of a callback slot that is called during rendering.
RenderSlot Definition of a callback slot that is called during rendering.
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

Callbacks
PreRenderSignal Gets the signal that is called before a model is rendered.
PostRenderSignal Gets the signal that is called after a model is rendered.
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.
GetMaterialCount Gets the number of materials.
GetMaterial Gets the material with the specified index number.
GetMaterialActivator Gets the material activator.
SetMaterialActivator Transfers ownership and sets the material activator. The material activator is also destroyed if the model class is destroyed.
SetSharedMaterialActivator Sets the material activator without transferring ownership. Set here if the material activator is managed on the user side.
Creation/Destruction
S Create Creates a model.
S GetMemorySize Gets the memory size required at time of creation.
DestroyBranch Destroys all nodes on the current branch, including the current node.(Derived from SceneNode.)
Destroy Destroys an object.(Derived from GfxObject.)
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
GetResModel Gets the model resource.
GetResMeshes Gets an array of mesh resources.
GetResMeshNodeVisibilities Gets the MeshNodeVisibility resource at the specified index.
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.)
Animation
GetMaterialAnimGroup Gets a material animation group.
GetMaterialAnimBindingIndex Gets the index among the animation bindings of a material animation group.
GetMaterialAnimObject Gets a material animation object.
SetMaterialAnimObject Configures a material animation object.
GetVisibilityAnimGroup Gets a visibility animation group.
GetVisibilityAnimBindingIndex Gets the animation binding index of a visibility animation group.
GetVisibilityAnimObject Gets a visibility animation object.
SetVisibilityAnimObject Sets a visibility animation object.
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.)
Buffer Options
CheckBufferOption Checks the buffer option.
GetBufferOption Gets the buffer option.
Matrices
ModelViewMatrix Gets the modelview matrix.
NormalMatrix Gets the normal matrix.
UpdateModelViewMatrixAndNormalMatrix Updates the modelview matrix and the normal matrix.
Layers
GetLayerId Gets the layer ID.
SetLayerId Sets the layer ID.
GetRenderLayerId Gets the render layer value of the mesh.
Rendering
IsVisible Gets a flag indicating whether to render the model.
SetVisible Sets a flag indicating whether to render the model.
IsMeshVisible Gets a flag indicating whether to render the mesh.
InvalidateRenderKeyCache Disables the key cache used for render sorting.
User Parameters
GetUserParameter Gets user parameters.
SetUserParameter Sets user parameters.
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 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.)
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 Model Constructor.
protected V ~Model Destructor.
Other
protected V Initialize Allocates memory for and initialized members.
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

CONFIDENTIAL