Panda3D
Public Member Functions | Static Public Member Functions | List of all members
SceneSetup Class Reference

This object holds the camera position, etc., and other general setup information for rendering a particular scene. More...

Inheritance diagram for SceneSetup:
TypedReferenceCount TypedObject ReferenceCount

Public Member Functions

 __init__ (const SceneSetup)
 
Camera getCameraNode ()
 Returns the camera used to render the scene. More...
 
const NodePath getCameraPath ()
 Returns the NodePath to the camera. More...
 
const TransformState getCameraTransform ()
 Returns the position of the camera relative to the starting node. More...
 
const TransformState getCsTransform ()
 Returns the transform from the camera's coordinate system to the GSG's internal coordinate system. More...
 
const TransformState getCsWorldTransform ()
 Returns the position from the starting node relative to the camera, in the GSG's internal coordinate system. More...
 
BoundingVolume getCullBounds ()
 Returns the bounding volume that should be used to perform view-frustum culling (in the space of get_cull_center()). More...
 
const NodePath getCullCenter ()
 Returns the point from which the culling operations will be performed. More...
 
DisplayRegion getDisplayRegion ()
 Returns the display region for the scene. More...
 
const RenderState getInitialState ()
 Returns the initial state as set by a previous call to set_initial_state(). More...
 
bool getInverted ()
 Returns the current setting of the inverted flag. More...
 
const Lens getLens ()
 Returns the particular Lens used for rendering. More...
 
const NodePath getSceneRoot ()
 Returns the root node of the scene. More...
 
int getViewportHeight ()
 Returns the height of the viewport (display region) in pixels. More...
 
int getViewportWidth ()
 Returns the width of the viewport (display region) in pixels. More...
 
const TransformState getWorldTransform ()
 Returns the position of the starting node relative to the camera. More...
 
 setCameraNode (Camera camera_node)
 Specifies the camera used to render the scene. More...
 
 setCameraPath (const NodePath camera_path)
 Specifies the NodePath to the camera. More...
 
 setCameraTransform (const TransformState camera_transform)
 Specifies the position of the camera relative to the starting node. More...
 
 setCsTransform (const TransformState cs_transform)
 Specifies the transform from the camera's coordinate system to the GSG's internal coordinate system. More...
 
 setCsWorldTransform (const TransformState cs_world_transform)
 Specifies the position from the starting node relative to the camera, in the GSG's internal coordinate system. More...
 
 setDisplayRegion (DisplayRegion display_region)
 Specifies the display region for the scene. More...
 
 setInitialState (const RenderState initial_state)
 Sets the initial state which is applied to all nodes in the scene, as if it were set at the top of the scene graph. More...
 
 setInverted (bool inverted)
 Changes the current setting of the inverted flag. More...
 
 setLens (const Lens lens)
 Indicates the particular Lens used for rendering. More...
 
 setSceneRoot (const NodePath scene_root)
 Specifies the root node of the scene. More...
 
 setViewportSize (int width, int height)
 Specifies the size of the viewport (display region), in pixels. More...
 
 setWorldTransform (const TransformState world_transform)
 Specifies the position of the starting node relative to the camera. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Detailed Description

This object holds the camera position, etc., and other general setup information for rendering a particular scene.

Member Function Documentation

◆ __init__()

__init__ ( const  SceneSetup)

◆ getCameraNode()

Camera getCameraNode ( )

Returns the camera used to render the scene.

◆ getCameraPath()

const NodePath getCameraPath ( )

Returns the NodePath to the camera.

◆ getCameraTransform()

const TransformState getCameraTransform ( )

Returns the position of the camera relative to the starting node.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getCsTransform()

const TransformState getCsTransform ( )

Returns the transform from the camera's coordinate system to the GSG's internal coordinate system.

◆ getCsWorldTransform()

const TransformState getCsWorldTransform ( )

Returns the position from the starting node relative to the camera, in the GSG's internal coordinate system.

◆ getCullBounds()

BoundingVolume getCullBounds ( )

Returns the bounding volume that should be used to perform view-frustum culling (in the space of get_cull_center()).

This is normally the current lens' bounding volume, but it may be overridden with Camera::set_cull_bounds().

◆ getCullCenter()

const NodePath getCullCenter ( )

Returns the point from which the culling operations will be performed.

This is normally the camera, but if camera->set_cull_center() has been specified, it will be that special node instead.

◆ getDisplayRegion()

DisplayRegion getDisplayRegion ( )

Returns the display region for the scene.

◆ getInitialState()

const RenderState getInitialState ( )

Returns the initial state as set by a previous call to set_initial_state().

◆ getInverted()

bool getInverted ( )

Returns the current setting of the inverted flag.

When this is true, the scene is rendered into the window upside-down, flipped like a mirror along the X axis.

◆ getLens()

const Lens getLens ( )

Returns the particular Lens used for rendering.

◆ getSceneRoot()

const NodePath getSceneRoot ( )

Returns the root node of the scene.

◆ getViewportHeight()

int getViewportHeight ( )

Returns the height of the viewport (display region) in pixels.

◆ getViewportWidth()

int getViewportWidth ( )

Returns the width of the viewport (display region) in pixels.

◆ getWorldTransform()

const TransformState getWorldTransform ( )

Returns the position of the starting node relative to the camera.

This is the inverse of the camera transform.

◆ setCameraNode()

setCameraNode ( Camera  camera_node)

Specifies the camera used to render the scene.

◆ setCameraPath()

setCameraPath ( const NodePath  camera_path)

Specifies the NodePath to the camera.

◆ setCameraTransform()

setCameraTransform ( const TransformState  camera_transform)

Specifies the position of the camera relative to the starting node.

◆ setCsTransform()

setCsTransform ( const TransformState  cs_transform)

Specifies the transform from the camera's coordinate system to the GSG's internal coordinate system.

◆ setCsWorldTransform()

setCsWorldTransform ( const TransformState  cs_world_transform)

Specifies the position from the starting node relative to the camera, in the GSG's internal coordinate system.

◆ setDisplayRegion()

setDisplayRegion ( DisplayRegion  display_region)

Specifies the display region for the scene.

◆ setInitialState()

setInitialState ( const RenderState  initial_state)

Sets the initial state which is applied to all nodes in the scene, as if it were set at the top of the scene graph.

◆ setInverted()

setInverted ( bool  inverted)

Changes the current setting of the inverted flag.

When this is true, the scene is rendered into the window upside-down and backwards, that is, inverted as if viewed through a mirror placed on the floor.

◆ setLens()

setLens ( const Lens  lens)

Indicates the particular Lens used for rendering.

◆ setSceneRoot()

setSceneRoot ( const NodePath  scene_root)

Specifies the root node of the scene.

◆ setViewportSize()

setViewportSize ( int  width,
int  height 
)

Specifies the size of the viewport (display region), in pixels.

◆ setWorldTransform()

setWorldTransform ( const TransformState  world_transform)

Specifies the position of the starting node relative to the camera.

This is the inverse of the camera transform.