Panda3D
 All Classes Functions Variables Enumerations
Public Member Functions | Static Public Member Functions | Friends | List of all members
Camera Class Reference

A node that can be positioned around in the scene graph to represent a point of view for rendering a scene. More...

#include "camera.h"

Inheritance diagram for Camera:
LensNode PandaNode TypedWritableReferenceCount Namable LinkedListNode TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase LightLensNode DirectionalLight PointLight Spotlight

Public Member Functions

 Camera (const string &name, Lens *lens=new PerspectiveLens())
 
 Camera (const Camera &copy)
 
int cleanup_aux_scene_data (Thread *current_thread=Thread::get_current_thread())
 Walks through the list of currently-assigned AuxSceneData objects and releases any that are past their expiration times. More...
 
bool clear_aux_scene_data (const NodePath &node_path)
 Removes the AuxSceneData associated with the indicated NodePath. More...
 
void clear_tag_state (const string &tag_state)
 Removes the association established by a previous call to set_tag_state(). More...
 
 CPT (RenderState) get_initial_state() const
 
 CPT (RenderState) get_tag_state(const string &tag_state) const
 
virtual TypeHandle force_init_type ()
 
AuxSceneDataget_aux_scene_data (const NodePath &node_path) const
 Returns the AuxSceneData associated with the indicated NodePath, or NULL if nothing is associated. More...
 
DrawMask get_camera_mask () const
 Returns the set of bits that represent the subset of the scene graph the camera will render. More...
 
BoundingVolumeget_cull_bounds () const
 Returns the custom cull volume that was set by set_cull_bounds(), if any, or NULL if no custom cull volume was set. More...
 
const NodePathget_cull_center () const
 Returns the point from which the culling operations will be performed, if it was set by set_cull_center(), or the empty NodePath otherwise. More...
 
DisplayRegionBaseget_display_region (int n) const
 Returns the nth display region associated with the camera. More...
 
const NodePathget_lod_center () const
 Returns the point from which the LOD distances will be measured, if it was set by set_lod_center(), or the empty NodePath otherwise. More...
 
PN_stdfloat get_lod_scale () const
 Returns the multiplier for LOD distances. More...
 
int get_num_display_regions () const
 Returns the number of display regions associated with the camera. More...
 
const NodePathget_scene () const
 Returns the scene that will be rendered by the camera. More...
 
const string & get_tag_state_key () const
 Returns the tag key as set by a previous call to set_tag_state_key(). More...
 
virtual TypeHandle get_type () const
 
bool has_tag_state (const string &tag_state) const
 Returns true if set_tag_state() has previously been called with the indicated tag state, false otherwise. More...
 
bool is_active () const
 Returns the current setting of the active flag on the camera. More...
 
void list_aux_scene_data (ostream &out) const
 Outputs all of the NodePaths and AuxSceneDatas in use. More...
 
virtual PandaNodemake_copy () const
 Returns a newly-allocated Node that is a shallow copy of this one. More...
 
 MAKE_SEQ (get_display_regions, get_num_display_regions, get_display_region)
 
virtual bool safe_to_flatten () const
 Returns true if it is generally safe to flatten out this particular kind of Node by duplicating instances, false otherwise (for instance, a Camera cannot be safely flattened, because the Camera pointer itself is meaningful). More...
 
virtual bool safe_to_transform () const
 Returns true if it is generally safe to transform this particular kind of Node by calling the xform() method, false otherwise. More...
 
void set_active (bool active)
 Sets the active flag on the camera. More...
 
void set_aux_scene_data (const NodePath &node_path, AuxSceneData *data)
 Associates the indicated AuxSceneData object with the given NodePath, possibly replacing a previous data defined for the same NodePath, if any. More...
 
void set_camera_mask (DrawMask mask)
 Changes the set of bits that represent the subset of the scene graph the camera will render. More...
 
void set_cull_bounds (BoundingVolume *cull_bounds)
 Specifies the bounding volume that should be used to perform culling from this camera. More...
 
void set_cull_center (const NodePath &cull_center)
 Specifies the point from which the culling operations are performed. More...
 
void set_initial_state (const RenderState *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...
 
void set_lod_center (const NodePath &lod_center)
 Specifies the point from which the LOD distances are measured. More...
 
void set_lod_scale (PN_stdfloat value)
 Sets the multiplier for LOD distances. More...
 
void set_scene (const NodePath &scene)
 Sets the scene that will be rendered by the camera. More...
 
void set_tag_state (const string &tag_state, const RenderState *state)
 Associates a particular state transition with the indicated tag value. More...
 
void set_tag_state_key (const string &tag_state_key)
 
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file. More...
 
- Public Member Functions inherited from LensNode
 LensNode (const string &name, Lens *lens=NULL)
 
bool activate_lens (int index)
 An alternate way to call set_lens_active(index, true). More...
 
virtual int complete_pointers (TypedWritable **plist, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
void copy_lens (const Lens &lens)
 Sets up the LensNode using a copy of the indicated Lens. More...
 
void copy_lens (int index, const Lens &lens)
 Copies the indicated lens into the specified slot. More...
 
bool deactivate_lens (int index)
 An alternate way to call set_lens_active(index, false). More...
 
Lensget_lens (int index=0) const
 Returns a pointer to the particular Lens associated with this LensNode, or NULL if there is not yet a Lens associated. More...
 
bool get_lens_active (int index) const
 Returns the active flag for the nth lens. More...
 
void hide_frustum ()
 Disables the drawing of the lens's frustum to aid in visualization. More...
 
bool is_in_view (const LPoint3 &pos)
 Returns true if the given point is within the bounds of the lens of the LensNode (i.e. More...
 
bool is_in_view (int index, const LPoint3 &pos)
 Returns true if the given point is within the bounds of the lens of the LensNode (i.e. More...
 
virtual void output (ostream &out) const
 
void set_lens (Lens *lens)
 Sets up the LensNode using this particular Lens pointer. More...
 
void set_lens (int index, Lens *lens)
 Sets the indicated lens. More...
 
bool set_lens_active (int index, bool active)
 Sets the active flag for the nth lens. More...
 
void show_frustum ()
 Enables the drawing of the lens's frustum to aid in visualization. More...
 
virtual void write (ostream &out, int indent_level=0) const
 
virtual void xform (const LMatrix4 &mat)
 Transforms the contents of this PandaNode by the indicated matrix, if it means anything to do so. More...
 
- Public Member Functions inherited from PandaNode
 PandaNode (const string &name)
 
void add_child (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 Adds a new child to the node. More...
 
virtual void add_for_draw (CullTraverser *trav, CullTraverserData &data)
 Adds the node's contents to the CullResult we are building up during the cull traversal, so that it will be drawn at render time. More...
 
void add_stashed (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 Adds a new child to the node, directly as a stashed child. More...
 
void adjust_draw_mask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
virtual void apply_attribs_to_vertices (const AccumulatedAttribs &attribs, int attrib_types, GeomTransformer &transformer)
 Applies whatever attributes are specified in the AccumulatedAttribs object (and by the attrib_types bitmask) to the vertices on this node, if appropriate. More...
 
virtual Lightas_light ()
 Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More...
 
void clear_attrib (TypeHandle type)
 Removes the render attribute of the given type from this node. More...
 
void clear_attrib (int slot)
 Removes the render attribute of the given type from this node. More...
 
void clear_bounds ()
 Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More...
 
void clear_effect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
void clear_effects (Thread *current_thread=Thread::get_current_thread())
 Resets this node to have no render effects. More...
 
void clear_state (Thread *current_thread=Thread::get_current_thread())
 Resets this node to leave the render state alone. More...
 
void clear_tag (const string &key, Thread *current_thread=Thread::get_current_thread())
 Removes the value defined for this key on this particular node. More...
 
void clear_transform (Thread *current_thread=Thread::get_current_thread())
 Resets the transform on this node to the identity transform. More...
 
void clear_unexpected_change (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. More...
 
virtual PandaNodecombine_with (PandaNode *other)
 Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined. More...
 
int compare_tags (const PandaNode *other) const
 Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. More...
 
void copy_all_properties (PandaNode *other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...
 
void copy_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Makes another instance of all the children of the other node, copying them to this node. More...
 
void copy_tags (PandaNode *other)
 Copies all of the tags stored on the other node onto this node. More...
 
int count_num_descendants () const
 Returns the number of nodes at and below this level. More...
 
virtual CPT (TransformState) calc_tight_bounds(LPoint3 &min_point
 
 CPT (RenderAttrib) get_attrib(TypeHandle type) const
 
 CPT (RenderAttrib) get_attrib(int slot) const
 
 CPT (RenderEffect) get_effect(TypeHandle type) const
 
 CPT (RenderState) get_state(Thread *current_thread
 
 CPT (RenderEffects) get_effects(Thread *current_thread
 
 CPT (TransformState) get_transform(Thread *current_thread
 
 CPT (TransformState) get_prev_transform(Thread *current_thread
 
 CPT (RenderAttrib) get_off_clip_planes(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(UpdateSeq &seq
 
 CPT (BoundingVolume) get_internal_bounds(Thread *current_thread
 
virtual bool cull_callback (CullTraverser *trav, CullTraverserData &data)
 This function will be called during the cull traversal to perform any additional operations that should be performed at cull time. More...
 
virtual PandaNodedupe_for_flatten () const
 This is similar to make_copy(), but it makes a copy for the specific purpose of flatten. More...
 
int find_child (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int find_parent (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int find_stashed (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
BoundingVolume::BoundsType get_bounds_type () const
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNodeget_child (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth child node of this node. More...
 
int get_child_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...
 
Children get_children (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of children of the node. More...
 
DrawMask get_draw_control_mask () const
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask get_draw_show_mask () const
 Returns the hide/show bits of this particular node. More...
 
int get_fancy_bits (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...
 
virtual int get_first_visible_child () const
 Returns the index number of the first visible child of this node, or a number >= get_num_children() if there are no visible children of this node. More...
 
int get_internal_vertices (Thread *current_thread=Thread::get_current_thread()) const
 
CollideMask get_into_collide_mask () const
 Returns the "into" collide mask for this node. More...
 
virtual CollideMask get_legal_collide_mask () const
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int get_nested_vertices (Thread *current_thread=Thread::get_current_thread()) const
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
CollideMask get_net_collide_mask (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask get_net_draw_control_mask () const
 Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More...
 
DrawMask get_net_draw_show_mask () const
 Returns the union of all draw_show_mask values–of renderable nodes only–at this level and below. More...
 
virtual int get_next_visible_child (int n) const
 Returns the index number of the next visible child of this node following the indicated child, or a number >= get_num_children() if there are no more visible children of this node. More...
 
int get_num_children (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of child nodes this node has. More...
 
int get_num_parents (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of parent nodes this node has. More...
 
int get_num_stashed (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of stashed nodes this node has. More...
 
PandaNodeget_parent (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth parent node of this node. More...
 
Parents get_parents (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed(). More...
 
PandaNodeget_stashed (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth stashed child of this node. More...
 
Stashed get_stashed (Thread *current_thread=Thread::get_current_thread()) const
 Returns an object that can be used to walk through the list of children of the node. More...
 
int get_stashed_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...
 
string get_tag (const string &key, Thread *current_thread=Thread::get_current_thread()) const
 Retrieves the user-defined value that was previously set on this node for the particular key, if any. More...
 
void get_tag_keys (vector_string &keys) const
 Fills the given vector up with the list of tags on this PandaNode. More...
 
unsigned int get_unexpected_change (unsigned int flags) const
 Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set. More...
 
virtual int get_unsafe_to_apply_attribs () const
 Returns the union of all attributes from SceneGraphReducer::AttribTypes that may not safely be applied to the vertices of this node. More...
 
virtual int get_visible_child () const
 Returns the index number of the currently visible child of this node. More...
 
bool has_attrib (TypeHandle type) const
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool has_attrib (int slot) const
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool has_dirty_prev_transform () const
 Returns true if this node has the _dirty_prev_transform flag set, which indicates its _prev_transform is different from its _transform value (in pipeline stage 0). More...
 
bool has_effect (TypeHandle type) const
 Returns true if there is a render effect of the indicated type defined on this node, or false if there is not. More...
 
virtual bool has_selective_visibility () const
 Should be overridden by derived classes to return true if this kind of node has some restrictions on the set of children that should be rendered. More...
 
virtual bool has_single_child_visibility () const
 Should be overridden by derived classes to return true if this kind of node has the special property that just one of its children is visible at any given time, and furthermore that the particular visible child can be determined without reference to any external information (such as a camera). More...
 
bool has_tag (const string &key, Thread *current_thread=Thread::get_current_thread()) const
 Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set. More...
 
bool has_tags () const
 Returns true if the node has any tags (or any Python tags) at all, false if it has none. More...
 
virtual bool is_ambient_light () const
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool is_bounds_stale () const
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
virtual bool is_collision_node () const
 A simple downcast check. More...
 
bool is_final (Thread *current_thread=Thread::get_current_thread()) const
 Returns the current state of the "final" flag. More...
 
virtual bool is_geom_node () const
 A simple downcast check. More...
 
virtual bool is_lod_node () const
 A simple downcast check. More...
 
bool is_overall_hidden () const
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
virtual bool is_renderable () const
 Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise. More...
 
bool is_scene_root () const
 Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More...
 
bool is_under_scene_root () const
 Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root. More...
 
void list_tags (ostream &out, const string &separator="\n") const
 Writes a list of all the tag keys assigned to the node to the indicated stream. More...
 
void ls (ostream &out, int indent_level) const
 Lists all the nodes at and below the current path hierarchically. More...
 
 MAKE_SEQ (get_parents, get_num_parents, get_parent)
 
 MAKE_SEQ (get_children, get_num_children, get_child)
 
 MAKE_SEQ (get_stashed, get_num_stashed, get_stashed)
 
void mark_bounds_stale (Thread *current_thread=Thread::get_current_thread()) const
 Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CData, like net_collide_mask), may have changed for this node, and that it must be recomputed. More...
 
void mark_internal_bounds_stale (Thread *current_thread=Thread::get_current_thread())
 Should be called by a derived class to mark the internal bounding volume stale, so that compute_internal_bounds() will be called when the bounding volume is next requested. More...
 
void prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state)
 Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG. More...
 
virtual bool preserve_name () const
 Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operation, false otherwise. More...
 
 PT (PandaNode) copy_subgraph(Thread *current_thread
 
virtual void r_prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state, GeomTransformer &transformer, Thread *current_thread)
 The recursive implementation of prepare_scene(). More...
 
void remove_all_children (Thread *current_thread=Thread::get_current_thread())
 Removes all the children from the node at once, including stashed children. More...
 
void remove_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth child from the node. More...
 
bool remove_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Removes the indicated child from the node. More...
 
void remove_stashed (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth stashed child from the node. More...
 
bool replace_child (PandaNode *orig_child, PandaNode *new_child, Thread *current_thread=Thread::get_current_thread())
 Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...
 
void replace_node (PandaNode *other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
void reset_prev_transform (Thread *current_thread=Thread::get_current_thread())
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
virtual bool safe_to_combine () const
 Returns true if it is generally safe to combine this particular kind of PandaNode with other kinds of PandaNodes of compatible type, adding children or whatever. More...
 
virtual bool safe_to_combine_children () const
 Returns true if it is generally safe to combine the children of this PandaNode with each other. More...
 
virtual bool safe_to_flatten_below () const
 Returns true if a flatten operation may safely continue past this node, or false if nodes below this node may not be molested. More...
 
virtual bool safe_to_modify_transform () const
 Returns true if it is safe to automatically adjust the transform on this kind of node. More...
 
void set_attrib (const RenderAttrib *attrib, int override=0)
 Adds the indicated render attribute to the scene graph on this node. More...
 
void set_bound (const BoundingVolume *volume)
 Deprecated. More...
 
void set_bounds (const BoundingVolume *volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
void set_bounds_type (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
void set_effect (const RenderEffect *effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
void set_effects (const RenderEffects *effects, Thread *current_thread=Thread::get_current_thread())
 Sets the complete RenderEffects that will be applied this node. More...
 
void set_final (bool flag)
 Sets the "final" flag on this PandaNode. More...
 
void set_into_collide_mask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
void set_overall_hidden (bool overall_hidden)
 Sets or clears the hidden flag. More...
 
void set_prev_transform (const TransformState *transform, Thread *current_thread=Thread::get_current_thread())
 Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More...
 
void set_state (const RenderState *state, Thread *current_thread=Thread::get_current_thread())
 Sets the complete RenderState that will be applied to all nodes at this level and below. More...
 
void set_tag (const string &key, const string &value, Thread *current_thread=Thread::get_current_thread())
 Associates a user-defined value with a user-defined key which is stored on the node. More...
 
void set_transform (const TransformState *transform, Thread *current_thread=Thread::get_current_thread())
 Sets the transform that will be applied to this node and below. More...
 
void set_unexpected_change (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. More...
 
bool stash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void stash_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void steal_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Moves all the children from the other node onto this node. More...
 
bool unstash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. More...
 
void unstash_child (int stashed_index, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
void write_recorder (BamWriter *manager, Datagram &dg)
 This method is provided for the benefit of classes (like MouseRecorder) that inherit from PandaMode and also RecorderBase. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More...
 
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const string &initial_name="")
 
 Namable (const Namable &copy)
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const string & get_name () const
 
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
Namableoperator= (const Namable &other)
 
void output (ostream &out) const
 Outputs the Namable. More...
 
void set_name (const string &name)
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type Camera. More...
 
- Static Public Member Functions inherited from LensNode
static TypeHandle get_class_type ()
 
static void init_type ()
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type LensNode. More...
 
- Static Public Member Functions inherited from PandaNode
static DrawMask get_all_camera_mask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle get_class_type ()
 
static DrawMask get_overall_bit ()
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
static void init_type ()
 
static PT (PandaNode) decode_from_bam_stream(const string &data
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type PandaNode. More...
 
static void reset_all_prev_transform (Thread *current_thread=Thread::get_current_thread())
 Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. More...
 
static void set_scene_root_func (SceneRootFunc *func)
 This is used by the GraphicsEngine to hook in a pointer to the scene_root_func(), the function to determine whether the node is an active scene root. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle get_class_type ()
 
static void init_type ()
 

Friends

class DisplayRegion
 

Additional Inherited Members

- Public Types inherited from PandaNode
enum  FancyBits {
  FB_transform = 0x0001, FB_state = 0x0002, FB_effects = 0x0004, FB_tag = 0x0010,
  FB_draw_mask = 0x0020, FB_cull_callback = 0x0040
}
 
typedef bool SceneRootFunc (const PandaNode *)
 
enum  UnexpectedChange {
  UC_parents = 0x001, UC_children = 0x002, UC_transform = 0x004, UC_state = 0x008,
  UC_draw_mask = 0x010
}
 
- Public Attributes inherited from PandaNode
virtual LPoint3 bool const
TransformState Thread
current_thread = Thread::get_current_thread()) const
 
Threadcurrent_thread = Thread::get_current_thread()) const
 
virtual LPoint3 bool & found_any
 
virtual LPoint3max_point
 
static BamReaderreader = NULL)
 
virtual LPoint3 bool const
TransformState * 
transform
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

Detailed Description

A node that can be positioned around in the scene graph to represent a point of view for rendering a scene.

Definition at line 37 of file camera.h.

Member Function Documentation

int Camera::cleanup_aux_scene_data ( Thread current_thread = Thread::get_current_thread())

Walks through the list of currently-assigned AuxSceneData objects and releases any that are past their expiration times.

Returns the number of elements released.

Definition at line 248 of file camera.cxx.

References ClockObject::get_frame_time(), and ClockObject::get_global_clock().

bool Camera::clear_aux_scene_data ( const NodePath node_path)

Removes the AuxSceneData associated with the indicated NodePath.

Returns true if it is removed successfully, false if it was already gone.

Definition at line 196 of file camera.cxx.

Referenced by set_aux_scene_data().

void Camera::clear_tag_state ( const string &  tag_state)

Removes the association established by a previous call to set_tag_state().

Definition at line 138 of file camera.cxx.

AuxSceneData * Camera::get_aux_scene_data ( const NodePath node_path) const

Returns the AuxSceneData associated with the indicated NodePath, or NULL if nothing is associated.

Definition at line 214 of file camera.cxx.

Referenced by FadeLODNode::cull_callback().

DrawMask Camera::get_camera_mask ( ) const
inline

Returns the set of bits that represent the subset of the scene graph the camera will render.

See set_camera_mask().

Definition at line 120 of file camera.I.

Referenced by CullTraverser::set_scene().

BoundingVolume * Camera::get_cull_bounds ( ) const
inline

Returns the custom cull volume that was set by set_cull_bounds(), if any, or NULL if no custom cull volume was set.

Definition at line 175 of file camera.I.

const NodePath & Camera::get_cull_center ( ) const
inline

Returns the point from which the culling operations will be performed, if it was set by set_cull_center(), or the empty NodePath otherwise.

Definition at line 147 of file camera.I.

DisplayRegionBase * Camera::get_display_region ( int  n) const
inline

Returns the nth display region associated with the camera.

Definition at line 86 of file camera.I.

const NodePath & Camera::get_lod_center ( ) const
inline

Returns the point from which the LOD distances will be measured, if it was set by set_lod_center(), or the empty NodePath otherwise.

Definition at line 203 of file camera.I.

PN_stdfloat Camera::get_lod_scale ( ) const
inline

Returns the multiplier for LOD distances.

Definition at line 260 of file camera.I.

Referenced by LODNode::cull_callback().

int Camera::get_num_display_regions ( ) const
inline

Returns the number of display regions associated with the camera.

Definition at line 75 of file camera.I.

const NodePath & Camera::get_scene ( ) const
inline

Returns the scene that will be rendered by the camera.

See set_scene().

Definition at line 64 of file camera.I.

Referenced by GraphicsEngine::render_frame().

const string & Camera::get_tag_state_key ( ) const
inline

Returns the tag key as set by a previous call to set_tag_state_key().

Definition at line 250 of file camera.I.

Referenced by CullTraverser::set_scene().

bool Camera::has_tag_state ( const string &  tag_state) const

Returns true if set_tag_state() has previously been called with the indicated tag state, false otherwise.

Definition at line 149 of file camera.cxx.

bool Camera::is_active ( ) const
inline

Returns the current setting of the active flag on the camera.

Definition at line 34 of file camera.I.

void Camera::list_aux_scene_data ( ostream &  out) const

Outputs all of the NodePaths and AuxSceneDatas in use.

Definition at line 231 of file camera.cxx.

PandaNode * Camera::make_copy ( ) const
virtual

Returns a newly-allocated Node that is a shallow copy of this one.

It will be a different Node pointer, but its internal data may or may not be shared with that of the original Node.

Reimplemented from LensNode.

Reimplemented in Spotlight, DirectionalLight, and PointLight.

Definition at line 78 of file camera.cxx.

void Camera::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type Camera.

Definition at line 305 of file camera.cxx.

References BamReader::get_factory(), and Factory< Type >::register_factory().

bool Camera::safe_to_flatten ( ) const
virtual

Returns true if it is generally safe to flatten out this particular kind of Node by duplicating instances, false otherwise (for instance, a Camera cannot be safely flattened, because the Camera pointer itself is meaningful).

Reimplemented from PandaNode.

Definition at line 92 of file camera.cxx.

bool Camera::safe_to_transform ( ) const
virtual

Returns true if it is generally safe to transform this particular kind of Node by calling the xform() method, false otherwise.

For instance, it's usually a bad idea to attempt to xform a Character.

Reimplemented from PandaNode.

Definition at line 105 of file camera.cxx.

void Camera::set_active ( bool  active)
inline

Sets the active flag on the camera.

When the camera is not active, nothing will be rendered.

Definition at line 23 of file camera.I.

Referenced by LightLensNode::set_shadow_caster().

void Camera::set_aux_scene_data ( const NodePath node_path,
AuxSceneData data 
)

Associates the indicated AuxSceneData object with the given NodePath, possibly replacing a previous data defined for the same NodePath, if any.

Definition at line 180 of file camera.cxx.

References clear_aux_scene_data().

Referenced by FadeLODNode::cull_callback().

void Camera::set_camera_mask ( DrawMask  mask)
inline

Changes the set of bits that represent the subset of the scene graph the camera will render.

During the cull traversal, a node is not visited if none of its draw mask bits intersect with the camera's camera mask bits. These masks can be used to selectively hide and show different parts of the scene graph from different cameras that are otherwise viewing the same scene.

Definition at line 105 of file camera.I.

References PandaNode::get_overall_bit().

void Camera::set_cull_bounds ( BoundingVolume cull_bounds)
inline

Specifies the bounding volume that should be used to perform culling from this camera.

Normally, this is the bounding volume returned from the active lens' make_bounds() call, but you may override this to specify a custom volume if you require. The specified bounding volume will be understood to be in the coordinate space of the get_cull_center() node.

Definition at line 163 of file camera.I.

void Camera::set_cull_center ( const NodePath cull_center)
inline

Specifies the point from which the culling operations are performed.

Normally, this is the same as the camera, and that is the default if this is not specified; but it may sometimes be useful to perform the culling from some other viewpoint, particularly when you are debugging the culling itself.

Definition at line 135 of file camera.I.

void Camera::set_initial_state ( const RenderState 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 215 of file camera.I.

void Camera::set_lod_center ( const NodePath lod_center)
inline

Specifies the point from which the LOD distances are measured.

Normally, this is the same as the camera, and that is the default if this is not specified; but it may sometimes be useful to perform the distance test from some other viewpoint. This may be used, for instance, to reduce LOD popping when the camera rotates in a small circle about an avatar.

Definition at line 191 of file camera.I.

void Camera::set_lod_scale ( PN_stdfloat  value)
inline

Sets the multiplier for LOD distances.

This value is multiplied with the LOD scale set on LodNodes.

Definition at line 271 of file camera.I.

void Camera::set_scene ( const NodePath scene)
inline

Sets the scene that will be rendered by the camera.

This is normally the root node of a scene graph, typically a node called 'render', although it could represent the root of any subgraph.

Note that the use of this method is now deprecated. In the absence of an explicit scene set on the camera, the camera will render whatever scene it is parented into. This is the preferred way to specify the scene, since it is the more intuitive mechanism.

Definition at line 53 of file camera.I.

void Camera::set_tag_state ( const string &  tag_state,
const RenderState state 
)

Associates a particular state transition with the indicated tag value.

When a node is encountered during traversal with the tag key specified by set_tag_state_key(), if the value of that tag matches tag_state, then the indicated state is applied to this node–but only when it is rendered by this camera.

This can be used to apply special effects to nodes when they are rendered by certain cameras. It is particularly useful for multipass rendering, in which specialty cameras might be needed to render the scene with a particular set of effects.

Definition at line 127 of file camera.cxx.

void Camera::write_datagram ( BamWriter manager,
Datagram dg 
)
virtual

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from LensNode.

Reimplemented in Spotlight, DirectionalLight, PointLight, and LightLensNode.

Definition at line 316 of file camera.cxx.

References Datagram::add_bool(), Datagram::add_uint32(), BitMask< WType, nbits >::get_word(), and LensNode::write_datagram().

Referenced by LightLensNode::write_datagram().


The documentation for this class was generated from the following files: