nw::gfx::Camera Class

Syntax

class Camera : public nw::gfx::TransformNode

Description

Class that represents a camera.

Classes

nw::gfx::Camera::DynamicBuilder Class for building cameras dynamically.

Structures

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

Enumerated Types

TraversalResults Definition of the bit flag indicating the traversal results.(Derived from SceneNode.

typedef Definitions

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

Create/Destroy
S Create Creates a camera from a resource.
DestroyBranch Destroys all nodes on the current branch, including the current node.(Derived from SceneNode.
Destroy Destroys an object.(Derived from GfxObject.
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
GetResCamera Gets the camera resource.
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.
Camera matrix
UpdateCameraMatrix Updates the view matrix and the projection matrix.
ProjectionMatrix Gets the projection matrix.
InverseProjectionMatrix Gets the inverse matrix of a projection matrix.
ViewMatrix Gets the view matrix.
InverseViewMatrix Gets the inverse matrix of a view matrix.
TextureProjectionMatrix Gets the projection matrix used for projection texture mapping.
Updater
GetViewUpdater Gets the view matrix updater.
SetViewUpdater Sets the view matrix updater.
SwapViewUpdater Sets the view matrix updater. The view matrix updater already configured is returned as a return value without being destroyed.
GetProjectionUpdater Gets the updater of a projection matrix.
SetProjectionUpdater Sets the projection matrix updater.
SwapProjectionUpdater Changes the projection matrix updater. The projection matrix updater already configured is returned as a return value without being destroyed.
WScale
GetWScale Gets WScale.
SetWScale Sets WScale.
Animation
GetAnimGroup Gets the animation group.
GetAnimObject Gets the animation object.
SetAnimObject Configures the 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.
View Updater Utility Functions
GetTargetPosition Gets the target coordinates for the configured view updater.
SetTargetPosition Sets the target coordinates for the configured view updater.
GetUpwardVector Gets the up vector of the configured view updater.
SetUpwardVector Sets the up vector of the configured view updater.
GetTwist Gets the twist of the configured view updater.
SetTwist Sets the twist of the configured view updater.
GetViewRotate Gets the rotation angle of the configured view updater.
SetViewRotate Sets the rotation angle of the configured view updater.
Projection Updater Utility Functions
GetPerspective Obtains the parameters for the projection app data configured for Perspective.
SetPerspective Sets the parameters for the projection updater configured for Perspective.
GetFrustum Obtains the parameters for the projection updater configured for Frustum.
SetFrustum Sets the parameters for the projection updater configured for Frustum.
GetOrtho Obtains the parameters for the projection app data configured for Ortho.
SetOrtho Sets the parameters for the projection updater configured for Ortho.
GetNear Gets the distance to the near clip plane of the projection updater being configured.
SetNear Sets the distance to the near clip plane of the projection updater being configured.
GetFar Gets the distance to the far clip plane of the projection updater being configured.
SetFar Sets the distance to the far clip plane of the projection updater being configured.
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.
Callbacks
PostCalculateWorldMatrixSignal Gets the signal after world matrix calculation.(Derived TransformNode.
PreUpdateSignal Gets the signal before the scene node is updated.(Derived from SceneNode.
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 Camera Constructor.
protected V ~Camera Destructor.
Other
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::Camera

CONFIDENTIAL