Panda3D
|
This object holds the camera position, etc., and other general setup information for rendering a particular scene. More...
#include "sceneSetup.h"
Public Member Functions | |
Camera * | get_camera_node () const |
Returns the camera used to render the scene. | |
const NodePath & | get_camera_path () const |
Returns the NodePath to the camera. | |
const TransformState * | get_camera_transform () const |
Returns the position of the camera relative to the starting node. | |
const NodePath & | get_cull_center () const |
Returns the point from which the culling operations will be performed. | |
DisplayRegion * | get_display_region () const |
Returns the display region for the scene. | |
const RenderState * | get_initial_state () const |
Returns the initial state as set by a previous call to set_initial_state(). | |
bool | get_inverted () const |
Returns the current setting of the inverted flag. | |
const Lens * | get_lens () const |
Returns the particular Lens used for rendering. | |
int | get_ref_count () const |
Returns the current reference count. | |
const NodePath & | get_scene_root () const |
Returns the root node of the scene. | |
int | get_viewport_height () const |
Returns the height of the viewport (display region) in pixels. | |
int | get_viewport_width () const |
Returns the width of the viewport (display region) in pixels. | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. | |
const TransformState * | get_world_transform () const |
Returns the position of the starting node relative to the camera. | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *, void *) |
void * | operator new (size_t size) |
void * | operator new (size_t size, void *ptr) |
void * | operator new[] (size_t size) |
void * | operator new[] (size_t size, void *ptr) |
void | ref () const |
Explicitly increments the reference count. | |
void | set_camera_node (Camera *camera_node) |
Specifies the camera used to render the scene. | |
void | set_camera_path (const NodePath &camera_path) |
Specifies the NodePath to the camera. | |
void | set_camera_transform (const TransformState *camera_transform) |
Specifies the position of the camera relative to the starting node. | |
void | set_display_region (DisplayRegion *display_region) |
Specifies the display region for the scene. | |
void | set_initial_state (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. | |
void | set_inverted (bool inverted) |
Changes the current setting of the inverted flag. | |
void | set_lens (const Lens *lens) |
Indicates the particular Lens used for rendering. | |
void | set_scene_root (const NodePath &scene_root) |
Specifies the root node of the scene. | |
void | set_viewport_size (int width, int height) |
Specifies the size of the viewport (display region), in pixels. | |
void | set_world_transform (const TransformState *world_transform) |
Specifies the position of the starting node relative to the camera. | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. | |
virtual bool | unref () const |
Explicitly decrements the reference count. | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. | |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static void | init_type () |
Protected Member Functions | |
bool | do_test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | do_test_ref_count_nonzero () const |
Returns true if the reference count is nonzero, false otherwise. |
This object holds the camera position, etc., and other general setup information for rendering a particular scene.
Definition at line 35 of file sceneSetup.h.
bool ReferenceCount::do_test_ref_count_integrity | ( | ) | const [protected, inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
Definition at line 29 of file referenceCount.cxx.
Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().
bool ReferenceCount::do_test_ref_count_nonzero | ( | ) | const [protected, inherited] |
Returns true if the reference count is nonzero, false otherwise.
Definition at line 56 of file referenceCount.cxx.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by ReferenceCount::test_ref_count_nonzero().
Camera * SceneSetup::get_camera_node | ( | ) | const [inline] |
Returns the camera used to render the scene.
Definition at line 142 of file sceneSetup.I.
Referenced by CullTraverserData::apply_transform_and_state(), FadeLODNode::cull_callback(), and CullTraverser::set_scene().
const NodePath & SceneSetup::get_camera_path | ( | ) | const [inline] |
Returns the NodePath to the camera.
Definition at line 122 of file sceneSetup.I.
const TransformState * SceneSetup::get_camera_transform | ( | ) | const [inline] |
Returns the position of the camera relative to the starting node.
Definition at line 250 of file sceneSetup.I.
Referenced by GraphicsStateGuardian::fetch_specified_part().
const NodePath & SceneSetup::get_cull_center | ( | ) | const [inline] |
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.
Definition at line 201 of file sceneSetup.I.
Referenced by PortalNode::cull_callback(), GraphicsEngine::do_cull(), and PortalClipper::prepare_portal().
DisplayRegion * SceneSetup::get_display_region | ( | ) | const [inline] |
Returns the display region for the scene.
Definition at line 48 of file sceneSetup.I.
Referenced by GraphicsEngine::do_cull(), DisplayRegionDrawCallbackData::upcall(), and DisplayRegionCullCallbackData::upcall().
const RenderState * SceneSetup::get_initial_state | ( | ) | const [inline] |
Returns the initial state as set by a previous call to set_initial_state().
Definition at line 228 of file sceneSetup.I.
Referenced by CullTraverser::set_scene().
bool SceneSetup::get_inverted | ( | ) | const [inline] |
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.
Definition at line 188 of file sceneSetup.I.
const Lens * SceneSetup::get_lens | ( | ) | const [inline] |
Returns the particular Lens used for rendering.
Definition at line 162 of file sceneSetup.I.
Referenced by ScissorEffect::cull_callback(), GraphicsEngine::do_cull(), PortalClipper::prepare_portal(), and GraphicsStateGuardian::set_scene().
int ReferenceCount::get_ref_count | ( | ) | const [inline, inherited] |
Returns the current reference count.
Definition at line 155 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by TransformState::clear_cache(), RenderState::clear_cache(), RenderState::finalize(), RenderEffects::finalize(), RenderEffect::finalize(), RenderAttrib::finalize(), InternalName::finalize(), TransformState::get_num_unused_states(), RenderState::get_num_unused_states(), TransformState::list_cycles(), RenderState::list_cycles(), GeomVertexFormat::remove_column(), TransformState::unref(), RenderState::unref(), RenderState::~RenderState(), and TransformState::~TransformState().
const NodePath & SceneSetup::get_scene_root | ( | ) | const [inline] |
Returns the root node of the scene.
Definition at line 102 of file sceneSetup.I.
Referenced by GraphicsEngine::do_cull().
int SceneSetup::get_viewport_height | ( | ) | const [inline] |
Returns the height of the viewport (display region) in pixels.
Definition at line 82 of file sceneSetup.I.
int SceneSetup::get_viewport_width | ( | ) | const [inline] |
Returns the width of the viewport (display region) in pixels.
Definition at line 71 of file sceneSetup.I.
WeakReferenceList * ReferenceCount::get_weak_list | ( | ) | const [inline, inherited] |
Returns the WeakReferenceList associated with this ReferenceCount object.
If there has never been a WeakReferenceList associated with this object, creates one now.
Definition at line 307 of file referenceCount.I.
Referenced by ReferenceCount::weak_ref().
const TransformState * SceneSetup::get_world_transform | ( | ) | const [inline] |
Returns the position of the starting node relative to the camera.
This is the inverse of the camera transform.
Definition at line 274 of file sceneSetup.I.
Referenced by GraphicsStateGuardian::fetch_specified_part().
bool ReferenceCount::has_weak_list | ( | ) | const [inline, inherited] |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).
Definition at line 294 of file referenceCount.I.
Referenced by ReferenceCount::weak_unref().
void ReferenceCount::local_object | ( | ) | [inline, inherited] |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.
Definition at line 276 of file referenceCount.I.
Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().
void ReferenceCount::ref | ( | ) | const [inline, inherited] |
Explicitly increments the reference count.
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
Definition at line 179 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().
void SceneSetup::set_camera_node | ( | Camera * | camera_node | ) | [inline] |
Specifies the camera used to render the scene.
Definition at line 132 of file sceneSetup.I.
void SceneSetup::set_camera_path | ( | const NodePath & | camera_path | ) | [inline] |
Specifies the NodePath to the camera.
Definition at line 112 of file sceneSetup.I.
void SceneSetup::set_camera_transform | ( | const TransformState * | camera_transform | ) | [inline] |
Specifies the position of the camera relative to the starting node.
Definition at line 239 of file sceneSetup.I.
void SceneSetup::set_display_region | ( | DisplayRegion * | display_region | ) | [inline] |
Specifies the display region for the scene.
Definition at line 38 of file sceneSetup.I.
void SceneSetup::set_initial_state | ( | const RenderState * | initial_state | ) | [inline] |
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.
Definition at line 217 of file sceneSetup.I.
void SceneSetup::set_inverted | ( | bool | inverted | ) | [inline] |
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.
Definition at line 175 of file sceneSetup.I.
void SceneSetup::set_lens | ( | const Lens * | lens | ) | [inline] |
Indicates the particular Lens used for rendering.
Definition at line 152 of file sceneSetup.I.
void SceneSetup::set_scene_root | ( | const NodePath & | scene_root | ) | [inline] |
Specifies the root node of the scene.
Definition at line 92 of file sceneSetup.I.
void SceneSetup::set_viewport_size | ( | int | width, |
int | height | ||
) | [inline] |
Specifies the size of the viewport (display region), in pixels.
Definition at line 59 of file sceneSetup.I.
void SceneSetup::set_world_transform | ( | const TransformState * | world_transform | ) | [inline] |
Specifies the position of the starting node relative to the camera.
This is the inverse of the camera transform.
Definition at line 262 of file sceneSetup.I.
bool ReferenceCount::test_ref_count_integrity | ( | ) | const [inline, inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
Definition at line 236 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by EggGroupNode::add_child(), InternalName::find_ancestor(), InternalName::get_ancestor(), ReferenceCount::get_ref_count(), InternalName::get_top(), ReferenceCount::ref(), EggVertex::test_gref_integrity(), EggVertex::test_pref_integrity(), EggNode::test_under_integrity(), EggPrimitive::test_vref_integrity(), EggGroup::test_vref_integrity(), MouseWatcher::throw_event_pattern(), ReferenceCount::unref(), and EggNode::update_under().
bool ReferenceCount::test_ref_count_nonzero | ( | ) | const [inline, inherited] |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
Returns true if ok, false otherwise.
Definition at line 252 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_nonzero().
Referenced by CopyOnWritePointer::test_ref_count_nonzero().
bool ReferenceCount::unref | ( | ) | const [inline, virtual, inherited] |
Explicitly decrements the reference count.
Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is true if the new reference count is nonzero, false if it is zero.
Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.
Definition at line 214 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().
void ReferenceCount::weak_ref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Adds the indicated PointerToVoid as a weak reference to this object.
Definition at line 321 of file referenceCount.I.
References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().
void ReferenceCount::weak_unref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Removes the indicated PointerToVoid as a weak reference to this object.
It must have previously been added via a call to weak_ref().
Definition at line 334 of file referenceCount.I.
References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().