nw::gfx::SceneContext Class

Syntax

class SceneContext : public nw::gfx::GfxObject

Description

Class for storing content during a scene analysis.

Classes

nw::gfx::SceneContext::Builder Class for building scene context classes.

Member Functions

Update
Clear Clears the scene analysis results.
Set/Get
PushSceneNode Adds a serialized scene node.
TryPushSceneNode Adds a serialized scene node.
GetSceneNodesBegin Gets the iterator pointing to the start of the serialized scene nodes.
GetSceneNodesEnd Gets the iterator pointing to the end of the serialized scene nodes.
GetSceneNodes Gets the iterators pointing to the start and end of the serialized scene nodes.
UserRenderNode Related
PushUserRenderNode Adds a serialized user-defined render node.
TryPushUserRenderNode Adds a serialized user-defined render node.
GetUserRenderNodesBegin This iterator points to the first user-defined render node.
GetUserRenderNodesEnd This iterator points to the last user-defined render node.
GetUserRenderNodes This iterator points to the first and last user-defined render nodes.
Model-related
PushModel Adds a model. Here, the term "model" includes the derived class (i.e., SkeletalModel, etc.)
TryPushModel Adds a model. Here, the term "model" includes the derived class (i.e., SkeletalModel, etc.)
GetModelsBegin Gets the iterator pointing to the start of the model.
GetModelsEnd Gets the iterator pointing to the end of the model.
PushSkeletalModel Adds a skeletal model.
TryPushSkeletalModel Adds a skeletal model.
GetSkeletalModelsBegin Gets the iterator pointing to the start of the skeletal model.
GetSkeletalModelsEnd Gets the iterator pointing to the end of the skeletal model.
Light-Related
PushLight Adds a light. Here, the term "light" includes derived classes (i.e., FragmentLight, etc.)
TryPushLight Adds a light. Here, the term "light" includes derived classes (i.e., FragmentLight, etc.)
GetLightsBegin Gets the iterator pointing to the start of the light.
GetLightsEnd Gets the iterator pointing to the end of the light.
PushFragmentLight Adds a fragment light.
TryPushFragmentLight Adds a fragment light.
GetFragmentLightsBegin Gets the iterator pointing to the start of the fragment light.
GetFragmentLightsEnd Gets the iterator pointing to the end of the fragment light.
PushVertexLight Adds a vertex light.
TryPushVertexLight Adds a vertex light.
GetVertexLightsBegin Gets the iterator pointing to the start of the vertex light.
GetVertexLightsEnd Gets the iterator pointing to the end of the vertex light.
PushHemiSphereLight Adds a hemispherical light.
TryPushHemiSphereLight Adds a hemispherical light.
GetHemiSphereLightsBegin Gets the iterator pointing to the start of the hemispherical light.
GetHemiSphereLightsEnd Gets the iterator pointing to the end of the hemispherical light.
PushAmbientLight Adds an ambient light.
TryPushAmbientLight Adds an ambient light.
GetAmbientLightsBegin Gets the iterator pointing to the start of the ambient light.
GetAmbientLightsEnd Gets the iterator pointing to the end of the ambient light.
Camera-Related
PushCamera Adds a camera.
TryPushCamera Adds a camera.
GetCameraBegin Gets the iterator pointing to the start of the camera.
GetCameraEnd Gets the iterator pointing to the end of the camera.
Fog-Related
PushFog Adds a fog object.
TryPushFog Adds a fog object.
GetFogBegin Gets the iterator pointing to the start of the fog.
GetFogEnd Gets the iterator pointing to the end of the fog.
Particle Set-Related
PushParticleSet Adds a particle set.
TryPushParticleSet Adds a particle set.
GetParticleSetBegin Gets the iterator pointing to the start of the particle set.
GetParticleSetEnd Gets the iterator pointing to the end of the particle set.
Particle emitter-related
PushParticleEmitter Adds a particle emitter.
TryPushParticleEmitter Adds a particle emitter.
GetParticleEmitterBegin Gets the iterator pointing to the start of the particle emitter.
GetParticleEmitterEnd Gets the iterator pointing to the end of the particle emitter.
Particle model-related
PushParticleModel Adds a particle model.
TryPushParticleModel Adds a particle model.
GetParticleModelBegin Gets the iterator pointing to the start of the particle model.
GetParticleModelEnd Gets the iterator pointing to the end of the particle emitter.
Animation-related
PushAnimatableNode Adds a node to be animated.
TryPushAnimatableNode Adds a node to be animated.
GetAnimatableNodesBegin Gets an iterator pointing to the start of the node to be animated.
GetAnimatableNodesEnd Gets an iterator pointing to the end of the node to be animated.
Create/Destroy
Destroy Destroys an object.(Derived from GfxObject.)

Class Hierarchy

nw::gfx::GfxObject
  nw::gfx::SceneContext

CONFIDENTIAL