nw::gfx::FragmentLight Class

Syntax

class FragmentLight : public nw::gfx::Light

Description

Class that represents a fragment light.

Classes

nw::gfx::FragmentLight::DynamicBuilder Class for building fragment lights dynamically.

Structures

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

Enumerated Types

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

typedef Definitions

ResPtr Definition of MovePtr for destroying light resources that were generated dynamically.
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_OriginalValue ResLight (Derived from Light.)
protected m_OriginalTransform math::Transform3 (Derived from Light.)
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

Set/Get
Direction Gets the light direction.
Transforms
V UpdateDirection Updates the direction information.
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 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.)
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 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
GetResFragmentLight Gets the resource of a fragment light.
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
GetAnimGroup Gets the animation group.(Derived from Light.)
GetAnimObject Gets the animation object.(Derived from Light.)
SetAnimObject Sets the animation object.(Derived from Light.)
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
PostCalculateWorldMatrixSignal Gets the signal after world matrix calculation.(Derived from TransformNode.)
PreUpdateSignal Gets the signal before the scene node is updated.(Derived from SceneNode.)
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.)
S GetMemorySize Gets the memory size required at time of creation.(Derived from SceneNode.)
Destroy Destroys an object.(Derived from GfxObject.)
S CreateClone Clones a resource and created a fragment light.
S GetMemorySizeForCreateClone Gets the memory size required at time of creation using CreateClone.
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 FragmentLight Constructor.
protected V ~FragmentLight Destructor.
Other
protected CreateAnimGroup Creates an animation group.(Derived from Light.)
protected GetAnimTargetObject Gets a pointer to model data to register to the animation.(Derived from Light.)
protected DestroyOriginalValue Destroys OriginalValue.(Derived from Light.)
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::Light
          nw::gfx::FragmentLight

CONFIDENTIAL