Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends

PGVirtualFrame Class Reference

This represents a frame that is rendered as a window onto another (possibly much larger) canvas. More...

#include "pgVirtualFrame.h"

Inheritance diagram for PGVirtualFrame:
PGItem PandaNode TypedWritable Namable LinkedListNode ReferenceCount TypedObject MemoryBase MemoryBase PGScrollFrame

List of all members.

Public Types

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 Member Functions

 PGVirtualFrame (const string &name="")
bool activate_region (const LMatrix4f &transform, int sort, const ClipPlaneAttrib *cpa, const ScissorAttrib *sa)
 Applies the indicated scene graph transform and order as determined by the traversal from PGTop.
void add_child (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 Adds a new child to the node.
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.
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.
void adjust_draw_mask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node.
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.
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.
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
virtual void candidate (const MouseWatcherParameter &param, bool background)
 This is a callback hook function, called whenever the user highlights an option in the IME window.
void clear_attrib (TypeHandle type)
 Removes the render attribute of the given type from this node.
void clear_attrib (int slot)
 Removes the render attribute of the given type from this node.
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.
void clear_clip_frame ()
 Removes the clip frame from the item.
void clear_effect (TypeHandle type)
 Removes the render effect of the given type from this node.
void clear_effects (Thread *current_thread=Thread::get_current_thread())
 Resets this node to have no render effects.
void clear_frame ()
 Removes the bounding rectangle from the item.
void clear_name ()
 Resets the Namable's name to empty.
void clear_state (Thread *current_thread=Thread::get_current_thread())
 Resets this node to leave the render state alone.
void clear_state_def (int state)
 Resets the NodePath assigned to the indicated state to its initial default, with only a frame representation if appropriate.
void clear_tag (const string &key, Thread *current_thread=Thread::get_current_thread())
 Removes the value defined for this key on this particular node.
void clear_transform (Thread *current_thread=Thread::get_current_thread())
 Resets the transform on this node to the identity transform.
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.
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.
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.
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().
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.
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.
void copy_tags (PandaNode *other)
 Copies all of the tags stored on the other node onto this node.
int count_num_descendants () const
 Returns the number of nodes at and below this level.
virtual CPT (TransformState) calc_tight_bounds(LPoint3f &min_point
 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 PandaNodedupe_for_flatten () const
 This is similar to make_copy(), but it makes a copy for the specific purpose of flatten.
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.
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.
virtual void enter_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse enters the region.
virtual void exit_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse exits the region.
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.
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.
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.
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.
virtual void focus_in ()
 This is a callback hook function, called whenever the widget gets the keyboard focus.
virtual void focus_out ()
 This is a callback hook function, called whenever the widget loses the keyboard focus.
virtual TypeHandle force_init_type ()
bool get_active () const
 Returns whether the PGItem is currently active for mouse events.
const RenderAttribget_attrib (TypeHandle type) const
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not.
const RenderAttribget_attrib (int slot) const
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not.
bool get_background_focus () const
 Returns whether background_focus is currently enabled.
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter.
int get_best_parent_from_Set (const std::set< int > &) const
BoundingVolume::BoundsType get_bounds_type () const
 Returns the bounding volume type set with set_bounds_type().
PandaNodeget_canvas_node () const
 Returns the special node that holds all of the children that appear in the virtual canvas.
PandaNodeget_canvas_parent () const
 Returns the parent node of the canvas_node.
const TransformStateget_canvas_transform () const
 Returns the transform of the virtual canvas.
PandaNodeget_child (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth child node of this node.
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()).
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.
const LVecBase4fget_clip_frame () const
 Returns the bounding rectangle of the clip frame.
DrawMask get_draw_control_mask () const
 Returns the set of bits in draw_show_mask that are considered meaningful.
DrawMask get_draw_show_mask () const
 Returns the hide/show bits of this particular node.
const RenderEffectget_effect (TypeHandle type) const
 Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not.
const RenderEffectsget_effects (Thread *current_thread=Thread::get_current_thread()) const
 Returns the complete RenderEffects that will be applied to this node.
string get_enter_event () const
 Returns the event name that will be thrown when the item is active and the mouse enters its frame, but not any nested frames.
string get_exit_event () const
 Returns the event name that will be thrown when the item is active and the mouse exits its frame, or enters a nested frame.
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.
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.
bool get_focus () const
 Returns whether the PGItem currently has focus for keyboard events.
string get_focus_in_event () const
 Returns the event name that will be thrown when the item gets the keyboard focus.
string get_focus_out_event () const
 Returns the event name that will be thrown when the item loses the keyboard focus.
const LVecBase4fget_frame () const
 Returns the bounding rectangle of the item.
LMatrix4f get_frame_inv_xform () const
 Returns the inverse of the frame transform matrix.
PGFrameStyle get_frame_style (int state)
 Returns the kind of frame that will be drawn behind the item when it is in the indicated state.
const string & get_id () const
 Returns the unique ID assigned to this PGItem.
int get_internal_vertices (Thread *current_thread=Thread::get_current_thread()) const
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children.
CollideMask get_into_collide_mask () const
 Returns the "into" collide mask for this node.
string get_keystroke_event () const
 Returns the event name that will be thrown when the item is active and any key is pressed by the user.
virtual CollideMask get_legal_collide_mask () const
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode.
const string & get_name () const
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.
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.
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.
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.
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.
PGItemNotifyget_notify () const
 Returns the object which will be notified when the PGItem changes, if any.
int get_num_children (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of child nodes this node has.
int get_num_parents (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of parent nodes this node has.
int get_num_stashed (Thread *current_thread=Thread::get_current_thread()) const
 Returns the number of stashed nodes this node has.
int get_num_state_defs () const
 Returns one more than the highest-numbered state def that was ever assigned to the PGItem.
PandaNodeget_parent (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth parent node of this node.
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().
string get_press_event (const ButtonHandle &button) const
 Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is depressed while the mouse is within the frame.
const TransformStateget_prev_transform (Thread *current_thread=Thread::get_current_thread()) const
 Returns the transform that has been set as this node's "previous" position.
int get_ref_count () const
 Returns the current reference count.
PGMouseWatcherRegionget_region () const
 Returns the MouseWatcherRegion associated with this item.
string get_release_event (const ButtonHandle &button) const
 Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button, formerly clicked down is within the frame, is released.
string get_repeat_event (const ButtonHandle &button) const
 Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is continuously held down while the mouse is within the frame.
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.
PandaNodeget_stashed (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the nth stashed child of this node.
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()).
int get_state () const
 Returns the "state" of this particular PGItem.
const RenderStateget_state (Thread *current_thread=Thread::get_current_thread()) const
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node.
NodePathget_state_def (int state)
 Returns the Node that is the root of the subgraph that will be drawn when the PGItem is in the indicated state.
int get_suppress_flags () const
 This is just an interface to get the suppress flags on the underlying MouseWatcherRegion.
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.
const TransformStateget_transform (Thread *current_thread=Thread::get_current_thread()) const
 Returns the transform that has been set on this particular node.
virtual TypeHandle get_type () const
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
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.
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.
virtual int get_visible_child () const
 Returns the index number of the currently visible child of this node.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
string get_within_event () const
 Returns the event name that will be thrown when the item is active and the mouse moves within the boundaries of the frame.
string get_without_event () const
 Returns the event name that will be thrown when the item is active and the mouse moves completely outside the boundaries of the frame.
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.
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.
bool has_clip_frame () const
 Returns true if the clip frame has been set; see set_clip_frame().
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).
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.
bool has_frame () const
 Returns true if the item has a bounding rectangle; see set_frame().
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty.
bool has_notify () const
 Returns true if there is an object configured to be notified when the PGItem changes, false otherwise.
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.
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).
bool has_state_def (int state) const
 Returns true if get_state_def() has ever been called for the indicated state (thus defining a render subgraph for this state index), false otherwise.
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.
bool has_tags () const
 Returns true if the node has any tags (or any Python tags) at all, false if it has none.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
NodePath instance_to_state_def (int state, const NodePath &path)
 Parents an instance of the bottom node of the indicated NodePath to the indicated state index.
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.
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.
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
bool is_final (Thread *current_thread=Thread::get_current_thread()) const
 Returns the current state of the "final" flag.
virtual bool is_geom_node () const
 A simple downcast check.
virtual bool is_lod_node () const
 A simple downcast check.
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
bool is_overall_hidden () const
 Returns true if the node has been hidden to all cameras by clearing its overall bit.
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.
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.
virtual void keystroke (const MouseWatcherParameter &param, bool background)
 This is a callback hook function, called whenever the user presses a key.
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.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void ls (ostream &out, int indent_level) const
 Lists all the nodes at and below the current path hierarchically.
 MAKE_SEQ (get_state_defs, get_num_state_defs, get_state_def)
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
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.
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.
virtual void move (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever a mouse is moved while within the region.
void operator delete (void *ptr, void *)
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
void operator delete (void *ptr)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
virtual void output (ostream &out) const
 Outputs the Namable.
void prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *net_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.
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.
virtual void press (const MouseWatcherParameter &param, bool background)
 This is a callback hook function, called whenever a mouse or keyboard button is depressed while the mouse is within the region.
 PT (PandaNode) copy_subgraph(Thread *current_thread
void ref () const
 Explicitly increments the reference count.
virtual void release (const MouseWatcherParameter &param, bool background)
 This is a callback hook function, called whenever a mouse or keyboard button previously depressed with press() is released.
void remove_all_children (Thread *current_thread=Thread::get_current_thread())
 Removes all the children from the node at once, including stashed children.
void remove_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth child from the node.
bool remove_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Removes the indicated child from the node.
void remove_stashed (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth stashed child from the node.
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.
void replace_node (PandaNode *other)
 Inserts this node into the scene graph in place of the other one, and removes the other node.
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.
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.
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.
virtual bool safe_to_combine_children () const
 Returns true if it is generally safe to combine the children of this PandaNode with each other.
virtual bool safe_to_flatten () const
 Returns true if it is generally safe to flatten out this particular kind of PandaNode by duplicating instances (by calling dupe_for_flatten()), false otherwise (for instance, a Camera cannot be safely flattened, because the Camera pointer itself is meaningful).
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.
virtual bool safe_to_modify_transform () const
 Returns true if it is safe to automatically adjust the transform on this kind of node.
virtual bool safe_to_transform () const
 Returns true if it is generally safe to transform this particular kind of PandaNode by calling the xform() method, false otherwise.
virtual void set_active (bool active)
 Sets whether the PGItem is active for mouse watching.
void set_attrib (const RenderAttrib *attrib, int override=0)
 Adds the indicated render attribute to the scene graph on this node.
void set_background_focus (bool focus)
 Sets the background_focus flag for this item.
void set_bound (const BoundingVolume *volume)
 Deprecated.
void set_bounds (const BoundingVolume *volume)
 Resets the bounding volume so that it is the indicated volume.
void set_bounds_type (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node.
void set_canvas_transform (const TransformState *transform)
 Changes the transform of the virtual canvas.
void set_clip_frame (float left, float right, float bottom, float top)
 Sets the bounding rectangle of the clip frame.
void set_clip_frame (const LVecBase4f &clip_frame)
 Sets the bounding rectangle of the clip frame.
void set_effect (const RenderEffect *effect)
 Adds the indicated render effect to the scene graph on this node.
void set_effects (const RenderEffects *effects, Thread *current_thread=Thread::get_current_thread())
 Sets the complete RenderEffects that will be applied this node.
void set_final (bool flag)
 Sets the "final" flag on this PandaNode.
virtual void set_focus (bool focus)
 Sets whether the PGItem currently has keyboard focus.
void set_frame (float left, float right, float bottom, float top)
 Sets the bounding rectangle of the item, in local coordinates.
void set_frame (const LVecBase4f &frame)
 Sets the bounding rectangle of the item, in local coordinates.
void set_frame_style (int state, const PGFrameStyle &style)
 Changes the kind of frame that will be drawn behind the item when it is in the indicated state.
void set_id (const string &id)
 Set the unique ID assigned to this PGItem.
void set_into_collide_mask (CollideMask mask)
 Sets the "into" CollideMask.
void set_name (const string &name)
void set_notify (PGItemNotify *notify)
 Sets the object which will be notified when the PGItem changes.
void set_overall_hidden (bool overall_hidden)
 Sets or clears the hidden flag.
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.
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.
void set_state (int state)
 Sets the "state" of this particular PGItem.
void set_suppress_flags (int suppress_flags)
 This is just an interface to set the suppress flags on the underlying MouseWatcherRegion.
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.
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.
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.
void setup (float width, float height)
 Creates a PGVirtualFrame with the indicated dimensions.
bool stash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node.
void stash_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node.
void steal_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Moves all the children from the other node onto this node.
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.
bool unstash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status.
void unstash_child (int stashed_index, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status.
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.
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.
virtual void within_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse moves within the boundaries of the region, even if it is also within the boundaries of a nested region.
virtual void without_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region.
virtual void write (ostream &out, int indent_level) const
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file.
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.
virtual void xform (const LMatrix4f &mat)
 Transforms the contents of this node by the indicated matrix, if it means anything to do so.

Static Public Member Functions

static void background_candidate (const MouseWatcherParameter &param)
 Calls candidate() on all the PGItems with background focus.
static void background_keystroke (const MouseWatcherParameter &param)
 Calls keystroke() on all the PGItems with background focus.
static void background_press (const MouseWatcherParameter &param)
 Calls press() on all the PGItems with background focus.
static void background_release (const MouseWatcherParameter &param)
 Calls release() on all the PGItems with background focus.
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.
static DrawMask get_all_camera_mask ()
 Returns a DrawMask that is appropriate for rendering to all cameras.
static TypeHandle get_class_type ()
static string get_enter_prefix ()
 Returns the prefix that is used to define the enter event for all PGItems.
static string get_exit_prefix ()
 Returns the prefix that is used to define the exit event for all PGItems.
static string get_focus_in_prefix ()
 Returns the prefix that is used to define the focus_in event for all PGItems.
static PGItemget_focus_item ()
 Returns the one PGItem in the world that currently has keyboard focus, if any, or NULL if no item has keyboard focus.
static string get_focus_out_prefix ()
 Returns the prefix that is used to define the focus_out event for all PGItems.
static string get_keystroke_prefix ()
 Returns the prefix that is used to define the keystroke event for all PGItems.
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.
static string get_press_prefix ()
 Returns the prefix that is used to define the press event for all PGItems.
static string get_release_prefix ()
 Returns the prefix that is used to define the release event for all PGItems.
static string get_repeat_prefix ()
 Returns the prefix that is used to define the repeat event for all PGItems.
static TextNodeget_text_node ()
 Returns the TextNode object that will be used by all PGItems to generate default labels given a string.
static string get_within_prefix ()
 Returns the prefix that is used to define the within event for all PGItems.
static string get_without_prefix ()
 Returns the prefix that is used to define the without event for all PGItems.
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.
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.
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.
static void set_text_node (TextNode *node)
 Changes the TextNode object that will be used by all PGItems to generate default labels given a string.

Public Attributes

virtual LPoint3f bool const
TransformState Thread
current_thread = Thread::get_current_thread()) const
Threadcurrent_thread = Thread::get_current_thread()) const
virtual LPoint3f bool & found_any
virtual LPoint3fmax_point
static BamReaderreader = NULL)
virtual LPoint3f bool const
TransformState
transform

Static Public Attributes

static TypedWritable *const Null = (TypedWritable*)0L

Protected Types

typedef pmap< PandaNode
*, PandaNode * > 
InstanceMap

Protected Member Functions

 PGVirtualFrame (const PGVirtualFrame &copy)
virtual void children_changed ()
 Called after a scene graph update that either adds or remove children from this node, this just provides a hook for derived PandaNode objects that need to update themselves based on the set of children the node has.
virtual void clip_frame_changed ()
 Called when the user changes the clip_frame size.
virtual void compute_internal_bounds (CPT(BoundingVolume)&internal_bounds, int &internal_vertices, int pipeline_stage, Thread *current_thread) const
 Called when needed to recompute the node's _internal_bound object.
 CPT (BoundingVolume) get_user_bounds(int pipeline_stage
 CPT (BoundingVolume) get_internal_bounds(int pipeline_stage
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.
void disable_cull_callback ()
 disables the call back
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.
virtual void draw_mask_changed ()
 Called after the node's draw_mask has been changed for any reason, this just provides a hook so derived classes can do something special in this case.
void fillin (DatagramIterator &scan, BamReader *manager)
 This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new PandaNode.
void fillin_recorder (DatagramIterator &scan, BamReader *manager)
 This internal function is called by make_recorder (in classes derived from RecorderBase, such as MouseRecorder) to read in all of the relevant data from the session file.
void force_bounds_stale (Thread *current_thread=Thread::get_current_thread())
 Similar to mark_bounds_stale(), except that the parents of this node marked stale even if this node was already considered stale.
void force_bounds_stale (int pipeline_stage, Thread *current_thread)
 Similar to mark_bounds_stale(), except that the parents of this node marked stale even if this node was already considered stale.
virtual void frame_changed ()
 Called when the user changes the frame size.
int get_internal_vertices (int pipeline_stage, Thread *current_thread) const
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children.
LVecBase4f get_relative_frame (PGItem *item) const
 Returns the LVecBase4f frame of the indicated item, converted into this item's coordinate space.
void insert_after (LinkedListNode *node)
 Adds a LinkedListNode record after the indicated node in the doubly-linked list.
void insert_before (LinkedListNode *node)
 Adds a LinkedListNode record before the indicated node in the doubly-linked list.
bool is_on_list () const
 Returns true if the node is member of any list, false if it has been removed or never added.
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.
virtual PandaNodemake_copy () const
 Returns a newly-allocated Node that is a shallow copy of this one.
void mark_bounds_stale (int pipeline_stage, Thread *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.
void mark_internal_bounds_stale (int pipeline_stage, Thread *current_thread)
 Should be called by a derived class to mark the internal bounding volume stale, so that recompute_internal_bounds() will be called when the bounding volume is next requested.
LPoint3f mouse_to_local (const LPoint2f &mouse_point) const
 Converts from the 2-d mouse coordinates into the coordinate space of the item.
virtual void parents_changed ()
 Called after a scene graph update that either adds or remove parents from this node, this just provides a hook for derived PandaNode objects that need to update themselves based on the set of parents the node has.
void play_sound (const string &event)
 Plays the sound associated with the indicated event, if there is one.
virtual void r_copy_children (const PandaNode *from, InstanceMap &inst_map, Thread *current_thread)
 This is called by r_copy_subgraph(); the copy has already been made of this particular node (and this is the copy); this function's job is to copy all of the children from the original.
virtual void r_mark_geom_bounds_stale (Thread *current_thread)
 Recursively calls Geom::mark_bounds_stale() on every Geom at this node and below.
virtual void r_prepare_scene (const RenderState *state, PreparedGraphicsObjects *prepared_objects, Thread *current_thread)
 The recursive implementation of prepare_scene().
void reduce_region (LVecBase4f &clip, PGItem *obscurer) const
 The frame parameter is an in/out parameter.
void reduce_region (LVecBase4f &frame, float px, float py) const
void remove_from_list ()
 Removes a LinkedListNode record from the doubly-linked list.
void set_cull_callback ()
 Intended to be called in the constructor by any subclass that defines cull_callback(), this sets up the flags to indicate that the cullback needs to be called.
void set_internal_bounds (const BoundingVolume *volume)
 This is provided as an alternate way for a node to set its own internal bounds, rather than overloading compute_internal_bounds().
virtual void state_changed ()
 Called after the node's RenderState has been changed for any reason, this just provides a hook so derived classes can do something special in this case.
void take_list_from (LinkedListNode *other_root)
 Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.
virtual void transform_changed ()
 Called after the node's transform has been changed for any reason, this just provides a hook so derived classes can do something special in this case.

Static Protected Member Functions

static TypedWritablemake_from_bam (const FactoryParams &params)
 This function is called by the BamReader's factory when a new object of type PandaNode is encountered in the Bam file.

Protected Attributes

LightReMutex _lock
LinkedListNode_next
LinkedListNode_prev
virtual Thread *current_thread const
Thread *current_thread const

Friends

class PandaNode::Children
class PandaNode::Stashed

Detailed Description

This represents a frame that is rendered as a window onto another (possibly much larger) canvas.

You can only see the portion of the canvas that is below the window at any given time.

This works simply by automatically defining a scissor effect to be applied to a special child node, called the canvas_node, of the PGVirtualFrame node. Every object that is parented to the canvas_node will be clipped by the scissor effect. Also, you can modify the canvas_transform through convenience methods here, which actually modifies the transform on the canvas_node.

The net effect is that the virtual canvas is arbitrarily large, and we can peek at it through the scissor region, and scroll through different parts of it by modifying the canvas_transform.

See PGScrollFrame for a specialization of this class that handles the traditional scrolling canvas, with scroll bars.

Definition at line 50 of file pgVirtualFrame.h.


Member Function Documentation

bool PGItem::activate_region ( const LMatrix4f transform,
int  sort,
const ClipPlaneAttrib cpa,
const ScissorAttrib sa 
) [inherited]

Applies the indicated scene graph transform and order as determined by the traversal from PGTop.

The return value is true if the region is valid, or false if it is empty or completely clipped.

Definition at line 425 of file pgItem.cxx.

References ScissorAttrib::get_frame(), NodePath::get_mat(), ClipPlaneAttrib::get_num_on_planes(), ClipPlaneAttrib::get_on_plane(), LMatrix4f::invert_from(), and NodePath::node().

Referenced by PGItem::cull_callback().

void PandaNode::add_child ( PandaNode child_node,
int  sort = 0,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Adds a new child to the node.

The child is added in the relative position indicated by sort; if all children have the same sort index, the child is added at the end.

If the same child is added to a node more than once, the previous instance is first removed.

Definition at line 726 of file pandaNode.cxx.

References PandaNode::children_changed(), PandaNode::force_bounds_stale(), TypedWritable::mark_bam_modified(), PandaNode::parents_changed(), and PandaNode::remove_child().

Referenced by PandaNode::copy_children(), EggLoader::make_polyset(), CharacterMaker::part_to_node(), SceneGraphReducer::r_flatten(), PGScrollFrame::setup(), PGSliderBar::setup_scroll_bar(), PGSliderBar::setup_slider(), LensNode::show_frustum(), PandaNode::steal_children(), and PathFind::trace_path().

void PandaNode::add_for_draw ( CullTraverser trav,
CullTraverserData data 
) [virtual, inherited]

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.

For most nodes other than GeomNodes, this is a do-nothing operation.

Reimplemented in GeomNode, and CallbackNode.

Definition at line 595 of file pandaNode.cxx.

Referenced by CullTraverser::traverse_below().

void PandaNode::add_stashed ( PandaNode child_node,
int  sort = 0,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Adds a new child to the node, directly as a stashed child.

The child is not added in the normal sense, but will be revealed if unstash_child() is called on it later.

If the same child is added to a node more than once, the previous instance is first removed.

This can only be called from the top pipeline stage (i.e. from App).

Definition at line 991 of file pandaNode.cxx.

References PandaNode::children_changed(), Thread::get_pipeline_stage(), TypedWritable::mark_bam_modified(), PandaNode::parents_changed(), and PandaNode::remove_child().

Referenced by PandaNode::copy_children(), EggLoader::make_polyset(), and PandaNode::steal_children().

void PandaNode::adjust_draw_mask ( DrawMask  show_mask,
DrawMask  hide_mask,
DrawMask  clear_mask 
) [inherited]

Adjusts the hide/show bits of this particular node.

These three parameters can be used to adjust the _draw_control_mask and _draw_show_mask independently, which work together to provide per-camera visibility for the node and its descendents.

_draw_control_mask indicates the bits in _draw_show_mask that are significant. Each different bit corresponds to a different camera (and these bits are assigned via Camera::set_camera_mask()).

Where _draw_control_mask has a 1 bit, a 1 bit in _draw_show_mask indicates the node is visible to that camera, and a 0 bit indicates the node is hidden to that camera. Where _draw_control_mask is 0, the node is hidden only if a parent node is hidden.

The meaning of the three parameters is as follows:

Wherever show_mask is 1, _draw_show_mask and _draw_control_mask will be set 1. Thus, show_mask indicates the set of cameras to which the node should be shown.

Wherever hide_mask is 1, _draw_show_mask will be set 0 and _draw_control_mask will be set 1. Thus, hide_mask indicates the set of cameras from which the node should be hidden.

Wherever clear_mask is 1, _draw_control_mask will be set 0. Thus, clear_mask indicates the set of cameras from which the hidden state should be inherited from a parent.

Definition at line 2072 of file pandaNode.cxx.

References PandaNode::draw_mask_changed(), Thread::get_current_thread(), BitMask< WType, nbits >::is_zero(), TypedWritable::mark_bam_modified(), and PandaNode::mark_bounds_stale().

Referenced by NodePath::hide(), PandaNode::set_overall_hidden(), NodePath::show(), and NodePath::show_through().

void PandaNode::apply_attribs_to_vertices ( const AccumulatedAttribs attribs,
int  attrib_types,
GeomTransformer transformer 
) [virtual, inherited]

Applies whatever attributes are specified in the AccumulatedAttribs object (and by the attrib_types bitmask) to the vertices on this node, if appropriate.

If this node uses geom arrays like a GeomNode, the supplied GeomTransformer may be used to unify shared arrays across multiple different nodes.

This is a generalization of xform().

Reimplemented in PartBundleNode, GeomNode, and TextNode.

Definition at line 356 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), and PandaNode::xform().

Referenced by SceneGraphReducer::r_apply_attribs().

Light * PandaNode::as_light ( ) [virtual, inherited]
ReferenceCount * PandaNode::as_reference_count ( ) [virtual, inherited]

Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.

Reimplemented from TypedWritable.

Definition at line 211 of file pandaNode.cxx.

TypedObject * TypedObject::as_typed_object ( ) [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 99 of file typedObject.I.

const TypedObject * TypedObject::as_typed_object ( ) const [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 110 of file typedObject.I.

void PGItem::background_candidate ( const MouseWatcherParameter param) [static, inherited]

Calls candidate() on all the PGItems with background focus.

Definition at line 853 of file pgItem.cxx.

References PGItem::candidate(), and PGItem::get_focus().

Referenced by PGMouseWatcherBackground::candidate().

void PGItem::background_keystroke ( const MouseWatcherParameter param) [static, inherited]

Calls keystroke() on all the PGItems with background focus.

Definition at line 836 of file pgItem.cxx.

References PGItem::get_focus(), and PGItem::keystroke().

Referenced by PGMouseWatcherBackground::keystroke().

void PGItem::background_press ( const MouseWatcherParameter param) [static, inherited]

Calls press() on all the PGItems with background focus.

Definition at line 802 of file pgItem.cxx.

References PGItem::get_focus(), and PGItem::press().

Referenced by PGMouseWatcherBackground::press().

void PGItem::background_release ( const MouseWatcherParameter param) [static, inherited]

Calls release() on all the PGItems with background focus.

Definition at line 819 of file pgItem.cxx.

References PGItem::get_focus(), and PGItem::release().

Referenced by PGMouseWatcherBackground::release().

void PGItem::candidate ( const MouseWatcherParameter param,
bool  background 
) [virtual, inherited]

This is a callback hook function, called whenever the user highlights an option in the IME window.

Reimplemented in PGEntry.

Definition at line 761 of file pgItem.cxx.

References PGItem::get_notify(), PGItem::has_notify(), and PGItemNotify::item_candidate().

Referenced by PGItem::background_candidate(), and PGMouseWatcherRegion::candidate().

void PandaNode::children_changed ( ) [protected, virtual, inherited]

Called after a scene graph update that either adds or remove children from this node, this just provides a hook for derived PandaNode objects that need to update themselves based on the set of children the node has.

Definition at line 2928 of file pandaNode.cxx.

Referenced by PandaNode::add_child(), PandaNode::add_stashed(), PandaNode::remove_all_children(), PandaNode::remove_child(), PandaNode::remove_stashed(), PandaNode::replace_child(), PandaNode::stash_child(), and PandaNode::unstash_child().

void PandaNode::clear_attrib ( TypeHandle  type) [inline, inherited]
void PandaNode::clear_attrib ( int  slot) [inherited]

Removes the render attribute of the given type from this node.

This node, and the subgraph below, will now inherit the indicated render attribute from the nodes above this one.

Definition at line 1213 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), PandaNode::mark_bounds_stale(), and PandaNode::state_changed().

void PandaNode::clear_bounds ( ) [inline, inherited]

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.

Definition at line 596 of file pandaNode.I.

References PandaNode::set_bounds().

void PGVirtualFrame::clear_clip_frame ( )

Removes the clip frame from the item.

This disables clipping.

Definition at line 188 of file pgVirtualFrame.cxx.

References clip_frame_changed().

Referenced by r_copy_children().

void PandaNode::clear_effect ( TypeHandle  type) [inherited]
void PandaNode::clear_effects ( Thread current_thread = Thread::get_current_thread()) [inline, inherited]

Resets this node to have no render effects.

Definition at line 372 of file pandaNode.I.

References PandaNode::set_effects().

Referenced by NodePath::clear_effects().

void PGItem::clear_frame ( ) [inline, inherited]

Removes the bounding rectangle from the item.

It will no longer be possible to position the mouse within the item; see set_frame().

Definition at line 157 of file pgItem.I.

References PGItem::frame_changed().

void Namable::clear_name ( ) [inline, inherited]

Resets the Namable's name to empty.

Reimplemented in AsyncTask.

Definition at line 64 of file namable.I.

void PandaNode::clear_state ( Thread current_thread = Thread::get_current_thread()) [inline, inherited]

Resets this node to leave the render state alone.

Nodes at this level and below will once again inherit their render state unchanged from the nodes above this level.

Definition at line 350 of file pandaNode.I.

References PandaNode::set_state().

void PGItem::clear_state_def ( int  state) [inherited]

Resets the NodePath assigned to the indicated state to its initial default, with only a frame representation if appropriate.

Definition at line 1004 of file pgItem.cxx.

References PandaNode::mark_internal_bounds_stale().

Referenced by PGWaitBar::setup(), setup(), PGScrollFrame::setup(), PGButton::setup(), PGSliderBar::setup_scroll_bar(), and PGSliderBar::setup_slider().

void PandaNode::clear_tag ( const string &  key,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Removes the value defined for this key on this particular node.

After a call to clear_tag(), has_tag() will return false for the indicated key.

Definition at line 1486 of file pandaNode.cxx.

References TypedWritable::mark_bam_modified().

Referenced by NodePath::clear_tag().

void PandaNode::clear_transform ( Thread current_thread = Thread::get_current_thread()) [inline, inherited]

Resets the transform on this node to the identity transform.

Definition at line 397 of file pandaNode.I.

References PandaNode::set_transform().

Referenced by NodePath::clear_mat().

void PandaNode::clear_unexpected_change ( unsigned int  flags) [inherited]

Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node.

See set_unexpected_change().

The input parameter is the union of bits that are to be cleared.

Since this is a developer debugging tool only, this function does nothing in a production (NDEBUG) build.

Definition at line 2027 of file pandaNode.cxx.

void PGVirtualFrame::clip_frame_changed ( ) [protected, virtual]

Called when the user changes the clip_frame size.

Definition at line 204 of file pgVirtualFrame.cxx.

Referenced by clear_clip_frame(), and set_clip_frame().

PandaNode * PandaNode::combine_with ( PandaNode other) [virtual, inherited]

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.

The return value may be this, other, or a new PandaNode altogether.

This function is called from GraphReducer::flatten(), and need not deal with children; its job is just to decide whether to collapse the two PandaNodes and what the collapsed PandaNode should look like.

Reimplemented in Character, CollisionNode, GeomNode, ModelNode, and PortalNode.

Definition at line 401 of file pandaNode.cxx.

References TypedObject::is_exact_type().

int PandaNode::compare_tags ( const PandaNode other) const [inherited]

Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one.

If this returns 0, the tags are identical. If it returns other than 0, then the tags are different; and the nodes may be sorted into a consistent (but arbitrary) ordering based on this number.

Definition at line 1720 of file pandaNode.cxx.

Referenced by SceneGraphReducer::consider_child().

int TypedWritable::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
) [virtual, inherited]

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

This is the callback function that is made by the BamReader at some later point, after all of the required pointers have been filled in. It is necessary because there might be forward references in a bam file; when we call read_pointer() in fillin(), the object may not have been read from the file yet, so we do not have a pointer available at that time. Thus, instead of returning a pointer, read_pointer() simply reserves a later callback. This function provides that callback. The calling object is responsible for keeping track of the number of times it called read_pointer() and extracting the same number of pointers out of the supplied vector, and storing them appropriately within the object.

Reimplemented in CFDoCullCommand, AnimBundleNode, AnimChannelMatrixDynamic, AnimChannelScalarDynamic, AnimGroup, MovingPartBase, PartBundle, PartBundleNode, PartGroup, Character, CharacterJoint, CharacterJointEffect, CharacterVertexSlider, JointVertexTransform, CollisionNode, DataNodeTransmit, GeomVertexArrayData, GeomVertexArrayFormat, GeomVertexData, GeomVertexFormat, SliderTable, TextureStage, TransformBlendTable, TransformTable, PiecewiseCurve, ClipPlaneAttrib, FogAttrib, LensNode, LightAttrib, MaterialAttrib, PortalNode, RenderEffects, RenderState, TexGenAttrib, TexMatrixAttrib, TexProjectorEffect, TextureAttrib, BamCacheIndex, RecorderFrame, EggFile, ImageFile, PaletteGroup, PaletteGroups, PaletteImage, PalettePage, Palettizer, SourceTextureImage, TextureImage, TexturePlacement, TextureProperties, and TextureReference.

Definition at line 103 of file typedWritable.cxx.

void PGItem::compute_internal_bounds ( CPT(BoundingVolume)&  internal_bounds,
int &  internal_vertices,
int  pipeline_stage,
Thread current_thread 
) const [protected, virtual, inherited]

Called when needed to recompute the node's _internal_bound object.

Nodes that contain anything of substance should redefine this to do the right thing.

Reimplemented from PandaNode.

Definition at line 307 of file pgItem.cxx.

References BoundingVolume::around(), PandaNode::get_bounds_type(), PandaNode::get_nested_vertices(), NodePath::is_empty(), and NodePath::node().

void PandaNode::copy_all_properties ( PandaNode other) [inherited]

Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one.

Typically this is used to prepare a node to replace another node in the scene graph (also see replace_node()).

Definition at line 1798 of file pandaNode.cxx.

References PandaNode::draw_mask_changed(), Thread::get_current_thread(), TypedWritable::mark_bam_modified(), PandaNode::mark_bounds_stale(), PandaNode::state_changed(), and PandaNode::transform_changed().

Referenced by PandaNode::replace_node().

void PandaNode::copy_children ( PandaNode other,
Thread current_thread = Thread::get_current_thread() 
) [inherited]
void PandaNode::copy_tags ( PandaNode other) [inherited]

Copies all of the tags stored on the other node onto this node.

If a particular tag exists on both nodes, the contents of this node's value is replaced by that of the other.

Definition at line 1617 of file pandaNode.cxx.

References Thread::get_current_thread(), and TypedWritable::mark_bam_modified().

int PandaNode::count_num_descendants ( ) const [inherited]

Returns the number of nodes at and below this level.

Definition at line 701 of file pandaNode.cxx.

References PandaNode::count_num_descendants(), PandaNode::Children::get_child(), PandaNode::get_children(), and PandaNode::Children::get_num_children().

Referenced by PandaNode::count_num_descendants().

bool PGItem::cull_callback ( CullTraverser trav,
CullTraverserData data 
) [protected, virtual, inherited]

This function will be called during the cull traversal to perform any additional operations that should be performed at cull time.

This may include additional manipulation of render state or additional visible/invisible decisions, or any other arbitrary operation.

Note that this function will *not* be called unless set_cull_callback() is called in the constructor of the derived class. It is necessary to call set_cull_callback() to indicated that we require cull_callback() to be called.

By the time this function is called, the node has already passed the bounding-volume test for the viewing frustum, and the node's transform and state have already been applied to the indicated CullTraverserData object.

The return value is true if this node should be visible, or false if it should be culled.

Reimplemented from PandaNode.

Reimplemented in PGEntry, PGScrollFrame, PGSliderBar, and PGWaitBar.

Definition at line 210 of file pgItem.cxx.

References PGItem::activate_region(), PGTop::add_region(), PGItem::get_active(), CullBinManager::get_bin_sort(), CullBinManager::get_bin_type(), CullBinManager::get_global_ptr(), CullTraverserData::get_net_transform(), PGItem::get_region(), PGItem::get_state(), PGItem::get_state_def(), PGItem::has_frame(), PGItem::has_state_def(), TypedObject::is_exact_type(), CullTraverserData::is_this_node_hidden(), NodePath::node(), and CullTraverser::traverse().

bool TypedWritable::decode_raw_from_bam_stream ( TypedWritable *&  ptr,
ReferenceCount *&  ref_ptr,
const string &  data,
BamReader reader = NULL 
) [static, inherited]

Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string.

Returns true on success, false on on error.

This variant sets the TypedWritable and ReferenceCount pointers separately; both are pointers to the same object. The reference count is not incremented; it is the caller's responsibility to manage the reference count.

Note that this method cannot be used to retrieve objects that do not inherit from ReferenceCount, because these objects cannot persist beyond the lifetime of the BamReader that reads them. To retrieve these objects from a bam stream, you must construct a BamReader directly.

If you happen to know that the particular object in question inherits from TypedWritableReferenceCount or PandaNode, consider calling the variant of decode_from_bam_stream() defined for those methods, which presents a simpler interface.

Definition at line 353 of file typedWritable.cxx.

References BamReader::init(), DatagramInputFile::open(), DatagramInputFile::read_header(), BamReader::read_object(), ReferenceCount::ref(), BamReader::resolve(), BamReader::set_source(), and ReferenceCount::unref().

void PandaNode::disable_cull_callback ( ) [protected, inherited]

disables the call back

Definition at line 3096 of file pandaNode.cxx.

References Thread::get_current_thread(), and TypedWritable::mark_bam_modified().

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().

void PGItem::draw_mask_changed ( ) [protected, virtual, inherited]

Called after the node's draw_mask has been changed for any reason, this just provides a hook so derived classes can do something special in this case.

Reimplemented from PandaNode.

Definition at line 176 of file pgItem.cxx.

References PGItem::get_notify(), PGItem::has_notify(), and PGItemNotify::item_draw_mask_changed().

PandaNode * PandaNode::dupe_for_flatten ( ) const [virtual, inherited]

This is similar to make_copy(), but it makes a copy for the specific purpose of flatten.

Typically, this will be a new PandaNode with a new pointer, but all of the internal data will always be shared with the original; whereas the new node returned by make_copy() might not share the internal data.

Reimplemented in Character.

Definition at line 226 of file pandaNode.cxx.

References PandaNode::make_copy().

Referenced by SceneGraphReducer::r_apply_attribs().

bool TypedWritable::encode_to_bam_stream ( string &  data,
BamWriter writer = NULL 
) const [inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.

Returns true on success, false on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 283 of file typedWritable.cxx.

References BamWriter::init(), DatagramOutputFile::open(), BamWriter::set_target(), DatagramOutputFile::write_header(), and BamWriter::write_object().

string TypedWritable::encode_to_bam_stream ( ) const [inline, inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.

Returns empty string on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 86 of file typedWritable.I.

void PGItem::enter_region ( const MouseWatcherParameter param) [virtual, inherited]

This is a callback hook function, called whenever the mouse enters the region.

The mouse is only considered to be "entered" in one region at a time; in the case of nested regions, it exits the outer region before entering the inner one.

Reimplemented in PGButton.

Definition at line 524 of file pgItem.cxx.

References PGItem::get_enter_event(), PGItem::get_notify(), PGItem::has_notify(), PGItemNotify::item_enter(), and PGItem::play_sound().

Referenced by PGMouseWatcherRegion::enter_region().

void PGItem::exit_region ( const MouseWatcherParameter param) [virtual, inherited]

This is a callback hook function, called whenever the mouse exits the region.

The mouse is only considered to be "entered" in one region at a time; in the case of nested regions, it exits the outer region before entering the inner one.

Reimplemented in PGButton.

Definition at line 551 of file pgItem.cxx.

References PGItem::get_exit_event(), PGItem::get_notify(), PGItem::has_notify(), PGItemNotify::item_exit(), and PGItem::play_sound().

Referenced by PGMouseWatcherRegion::exit_region().

void PandaNode::fillin ( DatagramIterator scan,
BamReader manager 
) [protected, virtual, inherited]
void PandaNode::fillin_recorder ( DatagramIterator scan,
BamReader manager 
) [protected, inherited]

This internal function is called by make_recorder (in classes derived from RecorderBase, such as MouseRecorder) to read in all of the relevant data from the session file.

It balances with write_recorder().

Reimplemented in MouseRecorder.

Definition at line 4348 of file pandaNode.cxx.

References DatagramIterator::get_string().

void TypedWritable::finalize ( BamReader manager) [virtual, inherited]

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.

Reimplemented in PartBundle, Geom, GeomPrimitive, GeomVertexArrayData, GeomVertexArrayFormat, GeomVertexData, InternalName, GeomNode, LightAttrib, RenderAttrib, RenderEffect, RenderEffects, RenderState, PaletteGroup, and Palettizer.

Definition at line 145 of file typedWritable.cxx.

Referenced by BamReader::finalize_now().

int PandaNode::find_child ( PandaNode node,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]

Returns the index of the indicated child node, if it is a child, or -1 if it is not.

Definition at line 111 of file pandaNode.I.

Referenced by PandaFramework::event_arrow_left(), PandaFramework::event_arrow_right(), NodePath::get_sort(), and PandaNode::stash_child().

int PandaNode::find_parent ( PandaNode node,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]

Returns the index of the indicated parent node, if it is a parent, or -1 if it is not.

Definition at line 54 of file pandaNode.I.

Referenced by NodePathComponent::output(), PandaNode::replace_node(), DataGraphTraverser::traverse_below(), and NodePath::verify_complete().

int PandaNode::find_stashed ( PandaNode node,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]

Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not.

Definition at line 220 of file pandaNode.I.

Referenced by NodePath::get_sort(), NodePath::get_stashed_ancestor(), PandaNode::is_under_scene_root(), NodePathComponent::output(), and PandaNode::unstash_child().

void PGItem::focus_in ( ) [virtual, inherited]

This is a callback hook function, called whenever the widget gets the keyboard focus.

Definition at line 630 of file pgItem.cxx.

References PGItem::get_focus_in_event(), PGItem::get_notify(), PGItem::has_notify(), PGItemNotify::item_focus_in(), and PGItem::play_sound().

Referenced by PGItem::set_focus().

void PGItem::focus_out ( ) [virtual, inherited]

This is a callback hook function, called whenever the widget loses the keyboard focus.

Definition at line 653 of file pgItem.cxx.

References PGItem::get_focus_out_event(), PGItem::get_notify(), PGItem::has_notify(), PGItemNotify::item_focus_out(), and PGItem::play_sound().

Referenced by PGItem::set_focus().

void PandaNode::force_bounds_stale ( Thread current_thread = Thread::get_current_thread()) [protected, inherited]

Similar to mark_bounds_stale(), except that the parents of this node marked stale even if this node was already considered stale.

With no parameters, this means to iterate through all stages including and upstream of the current pipeline stage.

Definition at line 2823 of file pandaNode.cxx.

Referenced by PandaNode::add_child(), PandaNode::remove_all_children(), PandaNode::remove_child(), PandaNode::remove_stashed(), PandaNode::stash_child(), and PandaNode::unstash_child().

void PandaNode::force_bounds_stale ( int  pipeline_stage,
Thread current_thread 
) [protected, inherited]

Similar to mark_bounds_stale(), except that the parents of this node marked stale even if this node was already considered stale.

Definition at line 2838 of file pandaNode.cxx.

References PandaNode::Parents::get_num_parents(), PandaNode::Parents::get_parent(), TypedWritable::mark_bam_modified(), and PandaNode::mark_bounds_stale().

void PGItem::frame_changed ( ) [protected, virtual, inherited]

Called when the user changes the frame size.

Reimplemented in PGScrollFrame, and PGSliderBar.

Definition at line 1286 of file pgItem.cxx.

References PGItem::get_notify(), PGItem::has_notify(), and PGItemNotify::item_frame_changed().

Referenced by PGItem::clear_frame(), and PGItem::set_frame().

bool PGItem::get_active ( ) const [inline, inherited]
DrawMask PandaNode::get_all_camera_mask ( ) [inline, static, inherited]

Returns a DrawMask that is appropriate for rendering to all cameras.

Definition at line 513 of file pandaNode.I.

const RenderAttrib * PandaNode::get_attrib ( TypeHandle  type) const [inline, inherited]

Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not.

This checks only what is set on this particular node level, and has nothing to do with what render attributes may be inherited from parent nodes.

Definition at line 235 of file pandaNode.I.

Referenced by AccumulatedAttribs::apply_to_node(), NodePath::clear_clip_plane(), NodePath::clear_light(), NodePath::clear_tex_gen(), NodePath::clear_tex_transform(), NodePath::clear_texture(), NodePath::compose_color_scale(), NodePath::get_antialias(), NodePath::get_attrib(), NodePath::get_audio_volume(), NodePath::get_bin_draw_order(), NodePath::get_bin_name(), NodePath::get_color(), NodePath::get_color_scale(), PolylightNode::get_color_scenegraph(), NodePath::get_depth_offset(), NodePath::get_depth_test(), NodePath::get_depth_write(), NodePath::get_fog(), NodePath::get_instance_count(), NodePath::get_render_mode(), NodePath::get_render_mode_perspective(), NodePath::get_render_mode_thickness(), NodePath::get_tex_gen(), NodePath::get_tex_gen_light(), NodePath::get_texture(), NodePath::get_transparency(), NodePath::get_two_sided(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_fog(), NodePath::has_fog_off(), NodePath::has_light(), NodePath::has_light_off(), NodePath::has_material(), NodePath::has_tex_gen(), NodePath::has_tex_transform(), NodePath::has_texture(), NodePath::has_texture_off(), NodePath::set_all_color_scale(), NodePath::set_alpha_scale(), NodePath::set_audio_volume(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_color_scale(), NodePath::set_instance_count(), NodePath::set_light(), NodePath::set_light_off(), NodePath::set_tex_gen(), NodePath::set_tex_transform(), NodePath::set_texture(), and NodePath::set_texture_off().

const RenderAttrib * PandaNode::get_attrib ( int  slot) const [inline, inherited]

Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not.

This checks only what is set on this particular node level, and has nothing to do with what render attributes may be inherited from parent nodes.

Definition at line 250 of file pandaNode.I.

bool PGItem::get_background_focus ( ) const [inline, inherited]

Returns whether background_focus is currently enabled.

See set_background_focus().

Definition at line 223 of file pgItem.I.

Referenced by PGEntry::press(), and PGItem::set_background_focus().

UpdateSeq TypedWritable::get_bam_modified ( ) const [inline, inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

Definition at line 66 of file typedWritable.I.

Referenced by BamWriter::consider_update(), and BamWriter::write_pointer().

BoundingVolume::BoundsType PandaNode::get_bounds_type ( ) const [inherited]

Returns the bounding volume type set with set_bounds_type().

Definition at line 2424 of file pandaNode.cxx.

Referenced by PGItem::compute_internal_bounds(), GeomNode::compute_internal_bounds(), and CollisionNode::compute_internal_bounds().

PandaNode * PGVirtualFrame::get_canvas_node ( ) const [inline]

Returns the special node that holds all of the children that appear in the virtual canvas.

Definition at line 90 of file pgVirtualFrame.I.

Referenced by r_copy_children().

PandaNode * PGVirtualFrame::get_canvas_parent ( ) const [inline]

Returns the parent node of the canvas_node.

Definition at line 101 of file pgVirtualFrame.I.

Referenced by r_copy_children().

const TransformState * PGVirtualFrame::get_canvas_transform ( ) const [inline]

Returns the transform of the virtual canvas.

This transform is applied to all child nodes of the canvas_node.

Definition at line 78 of file pgVirtualFrame.I.

PandaNode * PandaNode::get_child ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]
int PandaNode::get_child_sort ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]

Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()).

See get_num_children().

Definition at line 97 of file pandaNode.I.

Referenced by NodePath::get_sort(), SceneGraphReducer::r_flatten(), PandaNode::stash_child(), and PandaNode::steal_children().

PandaNode::Children PandaNode::get_children ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns an object that can be used to walk through the list of children of the node.

When you intend to visit multiple children, using this is slightly faster than calling get_child() directly on the PandaNode, since this object avoids reopening the PipelineCycler each time.

This object also protects you from self-modifying loops (e.g. adding or removing children during traversal), since a virtual copy of the children is made ahead of time. The virtual copy is fast--it is a form of copy-on-write, so the list is not actually copied unless it is modified during the traversal.

Definition at line 772 of file pandaNode.I.

Referenced by RigidBodyCombiner::collect(), FindApproxLevelEntry::consider_node(), PandaNode::copy_children(), PandaNode::count_num_descendants(), AnimBundleNode::find_anim_bundle(), SceneGraphReducer::flatten(), SceneGraphReducer::flatten_siblings(), NodePath::get_children(), SceneGraphReducer::r_collect_vertex_data(), SceneGraphReducer::r_decompose(), SceneGraphReducer::r_flatten(), SceneGraphReducer::r_make_compatible_state(), SceneGraphReducer::r_make_nonindexed(), PandaNode::r_mark_geom_bounds_stale(), SceneGraphReducer::r_premunge(), PandaNode::r_prepare_scene(), SceneGraphReducer::r_register_vertices(), SceneGraphReducer::r_remove_column(), SceneGraphReducer::r_unify(), MultitexReducer::scan(), and DataGraphTraverser::traverse_below().

const LVecBase4f & PGVirtualFrame::get_clip_frame ( ) const [inline]

Returns the bounding rectangle of the clip frame.

See set_clip_frame(). If has_clip_frame() is false, this returns the item's actual frame.

Definition at line 39 of file pgVirtualFrame.I.

References PGItem::get_frame().

Referenced by PGScrollFrame::get_virtual_frame().

DrawMask PandaNode::get_draw_control_mask ( ) const [inline, inherited]

Returns the set of bits in draw_show_mask that are considered meaningful.

See adjust_draw_mask().

Definition at line 559 of file pandaNode.I.

Referenced by SceneGraphReducer::consider_child(), and NodePath::get_hidden_ancestor().

DrawMask PandaNode::get_draw_show_mask ( ) const [inline, inherited]

Returns the hide/show bits of this particular node.

See adjust_draw_mask().

Definition at line 571 of file pandaNode.I.

Referenced by SceneGraphReducer::consider_child(), and NodePath::get_hidden_ancestor().

const RenderEffect * PandaNode::get_effect ( TypeHandle  type) const [inline, inherited]
const RenderEffects * PandaNode::get_effects ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns the complete RenderEffects that will be applied to this node.

Definition at line 361 of file pandaNode.I.

Referenced by SceneGraphReducer::consider_child(), NodePath::get_effects(), SceneGraphReducer::r_apply_attribs(), and SceneGraphReducer::r_flatten().

string PGItem::get_enter_event ( ) const [inline, inherited]

Returns the event name that will be thrown when the item is active and the mouse enters its frame, but not any nested frames.

Definition at line 425 of file pgItem.I.

References PGItem::get_enter_prefix(), and PGItem::get_id().

Referenced by PGItem::enter_region().

string PGItem::get_enter_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the enter event for all PGItems.

The enter event is the concatenation of this string followed by get_id().

Definition at line 295 of file pgItem.I.

Referenced by PGItem::get_enter_event().

string PGItem::get_exit_event ( ) const [inline, inherited]

Returns the event name that will be thrown when the item is active and the mouse exits its frame, or enters a nested frame.

Definition at line 438 of file pgItem.I.

References PGItem::get_exit_prefix(), and PGItem::get_id().

Referenced by PGItem::exit_region().

string PGItem::get_exit_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the exit event for all PGItems.

The exit event is the concatenation of this string followed by get_id().

Definition at line 307 of file pgItem.I.

Referenced by PGItem::get_exit_event().

int PandaNode::get_fancy_bits ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node.

If this returns 0, the node has nothing interesting about it. This is intended to speed traversal by quickly skipping past nodes that don't particularly affect the render state.

Definition at line 694 of file pandaNode.I.

int PandaNode::get_first_visible_child ( ) const [virtual, inherited]

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.

This is called during the cull traversal, but only if has_selective_visibility() has already returned true. See has_selective_visibility().

Reimplemented in SelectiveChildNode, SequenceNode, and SwitchNode.

Definition at line 519 of file pandaNode.cxx.

Referenced by CullTraverser::traverse_below().

bool PGItem::get_focus ( ) const [inline, inherited]
string PGItem::get_focus_in_event ( ) const [inline, inherited]

Returns the event name that will be thrown when the item gets the keyboard focus.

Definition at line 481 of file pgItem.I.

References PGItem::get_focus_in_prefix(), and PGItem::get_id().

Referenced by PGItem::focus_in().

string PGItem::get_focus_in_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the focus_in event for all PGItems.

The focus_in event is the concatenation of this string followed by get_id().

Unlike most item events, this event is thrown with no parameters.

Definition at line 346 of file pgItem.I.

Referenced by PGItem::get_focus_in_event().

PGItem * PGItem::get_focus_item ( ) [inline, static, inherited]

Returns the one PGItem in the world that currently has keyboard focus, if any, or NULL if no item has keyboard focus.

Use PGItem::set_focus() to activate or deactivate keyboard focus on a particular item.

Definition at line 573 of file pgItem.I.

string PGItem::get_focus_out_event ( ) const [inline, inherited]

Returns the event name that will be thrown when the item loses the keyboard focus.

Definition at line 493 of file pgItem.I.

References PGItem::get_focus_out_prefix(), and PGItem::get_id().

Referenced by PGItem::focus_out().

string PGItem::get_focus_out_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the focus_out event for all PGItems.

The focus_out event is the concatenation of this string followed by get_id().

Unlike most item events, this event is thrown with no parameters.

Definition at line 361 of file pgItem.I.

Referenced by PGItem::get_focus_out_event().

const LVecBase4f & PGItem::get_frame ( ) const [inline, inherited]

Returns the bounding rectangle of the item.

See set_frame(). It is an error to call this if has_frame() returns false.

Definition at line 131 of file pgItem.I.

References PGItem::has_frame().

Referenced by get_clip_frame(), PGItem::get_relative_frame(), PGSliderBar::recompute(), PGSliderBar::remanage(), and PGScrollFrame::remanage().

LMatrix4f PGItem::get_frame_inv_xform ( ) const [inline, inherited]

Returns the inverse of the frame transform matrix.

Definition at line 583 of file pgItem.I.

PGFrameStyle PGItem::get_frame_style ( int  state) [inherited]

Returns the kind of frame that will be drawn behind the item when it is in the indicated state.

Definition at line 1070 of file pgItem.cxx.

Referenced by PGScrollFrame::remanage().

const string & PGItem::get_id ( ) const [inline, inherited]
int PandaNode::get_internal_vertices ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children.

This may not include all vertices for certain dynamic effects.

Definition at line 626 of file pandaNode.I.

References Thread::get_pipeline_stage().

int PandaNode::get_internal_vertices ( int  pipeline_stage,
Thread current_thread 
) const [protected, inherited]

Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children.

This may not include all vertices for certain dynamic effects.

Definition at line 2753 of file pandaNode.cxx.

References PandaNode::compute_internal_bounds().

CollideMask PandaNode::get_into_collide_mask ( ) const [inline, inherited]

Returns the "into" collide mask for this node.

Reimplemented in CollisionNode.

Definition at line 582 of file pandaNode.I.

string PGItem::get_keystroke_event ( ) const [inline, inherited]

Returns the event name that will be thrown when the item is active and any key is pressed by the user.

Definition at line 547 of file pgItem.I.

References PGItem::get_id(), and PGItem::get_keystroke_prefix().

Referenced by PGItem::keystroke().

string PGItem::get_keystroke_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the keystroke event for all PGItems.

The keystroke event is the concatenation of this string followed by a hyphen and get_id().

Definition at line 413 of file pgItem.I.

Referenced by PGItem::get_keystroke_event().

CollideMask PandaNode::get_legal_collide_mask ( ) const [virtual, inherited]

Returns the subset of CollideMask bits that may be set for this particular type of PandaNode.

For most nodes, this is 0; it doesn't make sense to set a CollideMask for most kinds of nodes.

For nodes that can be collided with, such as GeomNode and CollisionNode, this returns all bits on.

Reimplemented in CollisionNode, and GeomNode.

Definition at line 2209 of file pandaNode.cxx.

References BitMask< WType, nbits >::all_off().

Referenced by PandaNode::set_into_collide_mask().

int PandaNode::get_nested_vertices ( Thread current_thread = Thread::get_current_thread()) const [inherited]

Returns the total number of vertices that will be rendered by this node and all of its descendents.

This is not necessarily an accurate count of vertices that will actually be rendered, since this will include all vertices of all LOD's, and it will also include hidden nodes. It may also omit or only approximate certain kinds of dynamic geometry. However, it will not include stashed nodes.

Definition at line 2547 of file pandaNode.cxx.

References Thread::get_pipeline_stage().

Referenced by PGItem::compute_internal_bounds().

CollideMask PandaNode::get_net_collide_mask ( Thread current_thread = Thread::get_current_thread()) const [inherited]

Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below.

Definition at line 2220 of file pandaNode.cxx.

References Thread::get_pipeline_stage().

Referenced by NodePath::get_collide_mask().

DrawMask PandaNode::get_net_draw_control_mask ( ) const [inherited]

Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited.

A 1 bit in any position of this mask indicates that (a) this node has renderable children, and (b) some child of this node has made an explicit hide() or show_through() call for the corresponding bit.

Definition at line 2114 of file pandaNode.cxx.

References Thread::get_current_thread(), and Thread::get_pipeline_stage().

DrawMask PandaNode::get_net_draw_show_mask ( ) const [inherited]

Returns the union of all draw_show_mask values--of renderable nodes only--at this level and below.

If any bit in this mask is 0, there is no reason to traverse below this node for a camera with the corresponding camera_mask.

The bits in this mask that do not correspond to a 1 bit in the net_draw_control_mask are meaningless (and will be set to 1). For bits that *do* correspond to a 1 bit in the net_draw_control_mask, a 1 bit indicates that at least one child should be visible, while a 0 bit indicates that all children are hidden.

Definition at line 2145 of file pandaNode.cxx.

References Thread::get_current_thread(), and Thread::get_pipeline_stage().

int PandaNode::get_next_visible_child ( int  n) const [virtual, inherited]

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.

See has_selective_visibility() and get_first_visible_child().

Reimplemented in SelectiveChildNode.

Definition at line 534 of file pandaNode.cxx.

Referenced by CullTraverser::traverse_below().

PGItemNotify * PGItem::get_notify ( ) const [inline, inherited]

Returns the object which will be notified when the PGItem changes, if any.

Returns NULL if there is no such object configured.

Reimplemented in PGButton, and PGSliderBar.

Definition at line 85 of file pgItem.I.

Referenced by PGItem::candidate(), PGItem::draw_mask_changed(), PGItem::enter_region(), PGItem::exit_region(), PGItem::focus_in(), PGItem::focus_out(), PGItem::frame_changed(), PGItem::keystroke(), PGItem::move(), PGItem::press(), PGItem::release(), PGItem::transform_changed(), PGItem::within_region(), and PGItem::without_region().

int PandaNode::get_num_children ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]
int PandaNode::get_num_parents ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns the number of parent nodes this node has.

If this number is greater than 1, the node has been multiply instanced. The order of the parent nodes is not meaningful and is not related to the order in which the node was instanced to them.

Definition at line 26 of file pandaNode.I.

Referenced by Fog::adjust_to_camera(), SceneGraphReducer::r_apply_attribs(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), and DataNode::write_connections().

int PandaNode::get_num_stashed ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns the number of stashed nodes this node has.

These are former children of the node that have been moved to the special stashed list via stash_child().

Definition at line 176 of file pandaNode.I.

Referenced by FindApproxLevelEntry::consider_node(), NodePath::get_stashed_children(), PandaNode::steal_children(), and PandaNode::unstash_child().

int PGItem::get_num_state_defs ( ) const [inherited]

Returns one more than the highest-numbered state def that was ever assigned to the PGItem.

The complete set of state defs assigned may then be retrieved by indexing from 0 to (get_num_state_defs() - 1).

This is only an upper limit on the actual number of state defs, since there may be holes in the list.

Definition at line 975 of file pgItem.cxx.

DrawMask PandaNode::get_overall_bit ( ) [inline, static, inherited]

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.

Definition at line 502 of file pandaNode.I.

Referenced by NodePath::hide(), CullTraverserData::is_this_node_hidden(), Camera::set_camera_mask(), NodePath::show(), and NodePath::show_through().

PandaNode * PandaNode::get_parent ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]

Returns the nth parent node of this node.

See get_num_parents(). Also see get_parents(), if your intention is to iterate through the complete list of parents; get_parents() is preferable in this case.

Definition at line 40 of file pandaNode.I.

Referenced by DataNode::write_connections().

PandaNode::Parents PandaNode::get_parents ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed().

Definition at line 808 of file pandaNode.I.

Referenced by PandaNode::is_under_scene_root(), and PandaNode::replace_node().

string PGItem::get_press_event ( const ButtonHandle button) const [inline, inherited]

Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is depressed while the mouse is within the frame.

Definition at line 507 of file pgItem.I.

References PGItem::get_id(), ButtonHandle::get_name(), and PGItem::get_press_prefix().

Referenced by PGItem::press().

string PGItem::get_press_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the press event for all PGItems.

The press event is the concatenation of this string followed by a button name, followed by a hyphen and get_id().

Definition at line 374 of file pgItem.I.

Referenced by PGItem::get_press_event().

const TransformState * PandaNode::get_prev_transform ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns the transform that has been set as this node's "previous" position.

See set_prev_transform().

Definition at line 409 of file pandaNode.I.

Referenced by NodePath::get_prev_transform().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
PGMouseWatcherRegion * PGItem::get_region ( ) const [inline, inherited]

Returns the MouseWatcherRegion associated with this item.

Every PGItem has a MouseWatcherRegion associated with it, that is created when the PGItem is created; it does not change during the lifetime of the PGItem. Even items that do not have a frame have an associated MouseWatcherRegion, although it will not be used in this case.

Definition at line 39 of file pgItem.I.

Referenced by PGItem::cull_callback().

LVecBase4f PGItem::get_relative_frame ( PGItem item) const [protected, inherited]

Returns the LVecBase4f frame of the indicated item, converted into this item's coordinate space.

Presumably, item is a child of this node.

Definition at line 1237 of file pgItem.cxx.

References NodePath::any_path(), NodePath::find_path_to(), PGItem::get_frame(), NodePath::get_mat(), and NodePath::is_empty().

Referenced by PGItem::reduce_region().

string PGItem::get_release_event ( const ButtonHandle button) const [inline, inherited]

Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button, formerly clicked down is within the frame, is released.

Definition at line 535 of file pgItem.I.

References PGItem::get_id(), ButtonHandle::get_name(), and PGItem::get_release_prefix().

Referenced by PGItem::release().

string PGItem::get_release_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the release event for all PGItems.

The release event is the concatenation of this string followed by a button name, followed by a hyphen and get_id().

Definition at line 400 of file pgItem.I.

Referenced by PGItem::get_release_event().

string PGItem::get_repeat_event ( const ButtonHandle button) const [inline, inherited]

Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is continuously held down while the mouse is within the frame.

Definition at line 521 of file pgItem.I.

References PGItem::get_id(), ButtonHandle::get_name(), and PGItem::get_repeat_prefix().

Referenced by PGItem::press().

string PGItem::get_repeat_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the repeat event for all PGItems.

The repeat event is the concatenation of this string followed by a button name, followed by a hyphen and get_id().

Definition at line 387 of file pgItem.I.

Referenced by PGItem::get_repeat_event().

PandaNode * PandaNode::get_stashed ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]

Returns the nth stashed child of this node.

See get_num_stashed(). Also see get_stashed(), if your intention is to iterate through the complete list of stashed children; get_stashed() is preferable in this case.

Definition at line 191 of file pandaNode.I.

Referenced by FindApproxLevelEntry::consider_node(), PandaNode::copy_children(), PandaNodePipelineReader::find_stashed(), NodePath::get_stashed_children(), PandaNode::r_mark_geom_bounds_stale(), SceneGraphReducer::r_premunge(), PandaNode::r_prepare_scene(), PandaNode::steal_children(), and PandaNode::unstash_child().

PandaNode::Stashed PandaNode::get_stashed ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns an object that can be used to walk through the list of children of the node.

When you intend to visit multiple children, using this is slightly faster than calling get_stashed() directly on the PandaNode, since this object avoids reopening the PipelineCycler each time.

This object also protects you from self-modifying loops (e.g. adding or removing children during traversal), since a virtual copy of the children is made ahead of time. The virtual copy is fast--it is a form of copy-on-write, so the list is not actually copied unless it is modified during the traversal.

Definition at line 795 of file pandaNode.I.

int PandaNode::get_stashed_sort ( int  n,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]

Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()).

See get_num_stashed().

Definition at line 206 of file pandaNode.I.

Referenced by NodePath::get_sort(), PandaNode::steal_children(), and PandaNode::unstash_child().

const RenderState * PandaNode::get_state ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node.

This returns only the RenderState set on this particular node, and has nothing to do with state that might be inherited from above.

Definition at line 336 of file pandaNode.I.

Referenced by AccumulatedAttribs::apply_to_node(), NodePath::clear_clip_plane(), NodePath::clear_light(), NodePath::clear_texture(), AccumulatedAttribs::collect(), SceneGraphReducer::consider_child(), NodePath::get_state(), SceneGraphReducer::r_apply_attribs(), SceneGraphReducer::r_premunge(), TextNode::r_prepare_scene(), PGItem::r_prepare_scene(), PandaNode::r_prepare_scene(), MultitexReducer::scan(), NodePath::set_texture(), and NodePath::set_texture_off().

int PGItem::get_state ( ) const [inline, inherited]

Returns the "state" of this particular PGItem.

See set_state().

Definition at line 187 of file pgItem.I.

Referenced by PGItem::cull_callback(), and PGScrollFrame::remanage().

NodePath & PGItem::get_state_def ( int  state) [inherited]

Returns the Node that is the root of the subgraph that will be drawn when the PGItem is in the indicated state.

The first time this is called for a particular state index, it may create the Node.

Definition at line 1026 of file pgItem.cxx.

Referenced by PGItem::cull_callback(), PGItem::instance_to_state_def(), PGItem::set_frame_style(), and PGButton::setup().

int PGItem::get_suppress_flags ( ) const [inline, inherited]

This is just an interface to get the suppress flags on the underlying MouseWatcherRegion.

See MouseWatcherRegion::get_suppress_flags().

Definition at line 249 of file pgItem.I.

string PandaNode::get_tag ( const string &  key,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]

Retrieves the user-defined value that was previously set on this node for the particular key, if any.

If no value has been previously set, returns the empty string.

Definition at line 437 of file pandaNode.I.

Referenced by NodePath::get_tag().

TextNode * PGItem::get_text_node ( ) [static, inherited]

Returns the TextNode object that will be used by all PGItems to generate default labels given a string.

This can be loaded with the default font, etc.

Definition at line 1160 of file pgItem.cxx.

Referenced by PGEntry::get_text_def(), and PGButton::setup().

const TransformState * PandaNode::get_transform ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]
int TypedObject::get_type_index ( ) const [inline, inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

This is equivalent to get_type().get_index().

Definition at line 52 of file typedObject.I.

References TypeHandle::get_index().

unsigned int PandaNode::get_unexpected_change ( unsigned int  flags) const [inherited]

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 specifically, this returns the particular set of bits (masked by the input parameter) that have been set on this node. See set_unexpected_change().

Since this is a developer debugging tool only, this function always returns zero in a production (NDEBUG) build.

Definition at line 2004 of file pandaNode.cxx.

int PandaNode::get_unsafe_to_apply_attribs ( ) const [virtual, inherited]

Returns the union of all attributes from SceneGraphReducer::AttribTypes that may not safely be applied to the vertices of this node.

If this is nonzero, these attributes must be dropped at this node as a state change.

This is a generalization of safe_to_transform().

Reimplemented in ModelNode, and TextNode.

Definition at line 339 of file pandaNode.cxx.

Referenced by SceneGraphReducer::r_apply_attribs().

int PandaNode::get_visible_child ( ) const [virtual, inherited]

Returns the index number of the currently visible child of this node.

This is only meaningful if has_single_child_visibility() has returned true.

Reimplemented in SequenceNode, and SwitchNode.

Definition at line 567 of file pandaNode.cxx.

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().

string PGItem::get_within_event ( ) const [inline, inherited]

Returns the event name that will be thrown when the item is active and the mouse moves within the boundaries of the frame.

This is different from the enter_event in that the mouse is considered within the frame even if it is also within a nested frame.

Definition at line 453 of file pgItem.I.

References PGItem::get_id(), and PGItem::get_within_prefix().

Referenced by PGItem::within_region().

string PGItem::get_within_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the within event for all PGItems.

The within event is the concatenation of this string followed by get_id().

Definition at line 319 of file pgItem.I.

Referenced by PGItem::get_within_event().

string PGItem::get_without_event ( ) const [inline, inherited]

Returns the event name that will be thrown when the item is active and the mouse moves completely outside the boundaries of the frame.

This is different from the exit_event in that the mouse is considered within the frame even if it is also within a nested frame.

Definition at line 469 of file pgItem.I.

References PGItem::get_id(), and PGItem::get_without_prefix().

Referenced by PGItem::without_region().

string PGItem::get_without_prefix ( ) [inline, static, inherited]

Returns the prefix that is used to define the without event for all PGItems.

The without event is the concatenation of this string followed by get_id().

Definition at line 331 of file pgItem.I.

Referenced by PGItem::get_without_event().

bool PandaNode::has_attrib ( TypeHandle  type) const [inline, inherited]
bool PandaNode::has_attrib ( int  slot) const [inline, inherited]

Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not.

Definition at line 276 of file pandaNode.I.

bool PGVirtualFrame::has_clip_frame ( ) const [inline]

Returns true if the clip frame has been set; see set_clip_frame().

If it has not been set, objects in the virtual frame will not be clipped.

Definition at line 52 of file pgVirtualFrame.I.

bool PandaNode::has_dirty_prev_transform ( ) const [inline, inherited]

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).

In this case, the node will be visited by reset_prev_transform().

Definition at line 424 of file pandaNode.I.

bool PandaNode::has_effect ( TypeHandle  type) const [inline, inherited]

Returns true if there is a render effect of the indicated type defined on this node, or false if there is not.

Definition at line 320 of file pandaNode.I.

Referenced by NodePath::has_billboard(), NodePath::has_compass(), and NodePath::has_effect().

bool PGItem::has_frame ( ) const [inline, inherited]

Returns true if the item has a bounding rectangle; see set_frame().

Definition at line 144 of file pgItem.I.

Referenced by PGItem::cull_callback(), PGItem::get_frame(), and PGSliderBar::recompute().

bool Namable::has_name ( ) const [inline, inherited]
bool PGItem::has_notify ( ) const [inline, inherited]
bool PandaNode::has_selective_visibility ( ) const [virtual, inherited]

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.

Node with this property include LODNodes, SwitchNodes, and SequenceNodes.

If this function returns true, get_first_visible_child() and get_next_visible_child() will be called to walk through the list of children during cull, instead of iterating through the entire list. This method is called after cull_callback(), so cull_callback() may be responsible for the decisions as to which children are visible at the moment.

Reimplemented in SelectiveChildNode.

Definition at line 504 of file pandaNode.cxx.

Referenced by CullTraverser::traverse_below().

bool PandaNode::has_single_child_visibility ( ) const [virtual, inherited]

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).

At present, only SequenceNodes and SwitchNodes fall into this category.

If this function returns true, get_visible_child() can be called to return the index of the currently-visible child.

Reimplemented in SequenceNode, and SwitchNode.

Definition at line 555 of file pandaNode.cxx.

bool PGItem::has_state_def ( int  state) const [inherited]

Returns true if get_state_def() has ever been called for the indicated state (thus defining a render subgraph for this state index), false otherwise.

Definition at line 988 of file pgItem.cxx.

Referenced by PGItem::cull_callback().

bool PandaNode::has_tag ( const string &  key,
Thread current_thread = Thread::get_current_thread() 
) const [inline, inherited]

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.

Definition at line 455 of file pandaNode.I.

Referenced by NodePath::has_tag().

bool PandaNode::has_tags ( ) const [inline, inherited]

Returns true if the node has any tags (or any Python tags) at all, false if it has none.

Definition at line 469 of file pandaNode.I.

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 LinkedListNode::insert_after ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record after the indicated node in the doubly-linked list.

Definition at line 108 of file linkedListNode.I.

void LinkedListNode::insert_before ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record before the indicated node in the doubly-linked list.

Definition at line 91 of file linkedListNode.I.

Referenced by SimpleAllocator::do_alloc(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

NodePath PGItem::instance_to_state_def ( int  state,
const NodePath path 
) [inherited]

Parents an instance of the bottom node of the indicated NodePath to the indicated state index.

Definition at line 1051 of file pgItem.cxx.

References PGItem::get_state_def(), NodePath::instance_to(), NodePath::is_empty(), and PandaNode::mark_internal_bounds_stale().

Referenced by PGButton::setup().

bool PandaNode::is_ambient_light ( ) const [virtual, inherited]

Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light.

Reimplemented in AmbientLight.

Definition at line 2664 of file pandaNode.cxx.

Referenced by LightAttrib::get_most_important_light().

bool PandaNode::is_bounds_stale ( ) const [inline, inherited]

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.

Definition at line 640 of file pandaNode.I.

bool TypedObject::is_exact_type ( TypeHandle  handle) const [inline, inherited]
bool PandaNode::is_final ( Thread current_thread = Thread::get_current_thread()) const [inline, inherited]

Returns the current state of the "final" flag.

Initially, this flag is off (false), but it may be changed by an explicit call to set_final(). See set_final().

Definition at line 678 of file pandaNode.I.

bool PandaNode::is_geom_node ( ) const [virtual, inherited]
bool PandaNode::is_lod_node ( ) const [virtual, inherited]

A simple downcast check.

Returns true if this kind of node happens to inherit from LODNode, false otherwise.

This is provided as a a faster alternative to calling is_of_type(LODNode::get_class_type()).

Reimplemented in LODNode.

Definition at line 2641 of file pandaNode.cxx.

bool TypedObject::is_of_type ( TypeHandle  handle) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 63 of file typedObject.I.

References TypeHandle::is_derived_from().

Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().

bool LinkedListNode::is_on_list ( ) const [inline, protected, inherited]

Returns true if the node is member of any list, false if it has been removed or never added.

The head of a list generally appears to to always be a member of itself.

Definition at line 62 of file linkedListNode.I.

bool PandaNode::is_overall_hidden ( ) const [inline, inherited]

Returns true if the node has been hidden to all cameras by clearing its overall bit.

Definition at line 524 of file pandaNode.I.

Referenced by FindApproxLevelEntry::consider_next_step(), NodePath::get_hidden_ancestor(), and PGItem::reduce_region().

bool PGItem::is_renderable ( ) const [protected, virtual, inherited]

Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise.

This will be used to optimize the result of get_net_draw_show_mask(), so that any subtrees that contain only nodes for which is_renderable() is false need not be visited.

Reimplemented from PandaNode.

Definition at line 294 of file pgItem.cxx.

bool PandaNode::is_scene_root ( ) const [inherited]

Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise.

Definition at line 2285 of file pandaNode.cxx.

Referenced by PandaNode::is_under_scene_root().

bool PandaNode::is_under_scene_root ( ) const [inherited]

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.

If this is true, this node may potentially be traversed by the render traverser. Stashed nodes don't count for this purpose, but hidden nodes do.

Definition at line 2306 of file pandaNode.cxx.

References PandaNode::find_stashed(), PandaNode::Parents::get_num_parents(), PandaNode::Parents::get_parent(), PandaNode::get_parents(), PandaNode::is_scene_root(), and PandaNode::is_under_scene_root().

Referenced by SceneGraphReducer::check_live_flatten(), and PandaNode::is_under_scene_root().

void PGItem::keystroke ( const MouseWatcherParameter param,
bool  background 
) [virtual, inherited]

This is a callback hook function, called whenever the user presses a key.

Reimplemented in PGEntry.

Definition at line 735 of file pgItem.cxx.

References PGItem::get_keystroke_event(), PGItem::get_notify(), PGItem::has_notify(), PGItemNotify::item_keystroke(), and PGItem::play_sound().

Referenced by PGItem::background_keystroke(), and PGMouseWatcherRegion::keystroke().

void PandaNode::list_tags ( ostream &  out,
const string &  separator = "\n" 
) const [inherited]

Writes a list of all the tag keys assigned to the node to the indicated stream.

Writes one instance of the separator following each key (but does not write a terminal separator). The value associated with each key is not written.

This is mainly for the benefit of the realtime user, to see the list of all of the associated tag keys.

Definition at line 1680 of file pandaNode.cxx.

Referenced by NodePath::list_tags().

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 PandaNode::ls ( ostream &  out,
int  indent_level 
) const [inline, inherited]

Lists all the nodes at and below the current path hierarchically.

Definition at line 489 of file pandaNode.I.

Referenced by NodePath::ls(), and PGEntry::setup_minimal().

PandaNode * PGVirtualFrame::make_copy ( ) const [protected, 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 PGItem.

Reimplemented in PGScrollFrame.

Definition at line 74 of file pgVirtualFrame.cxx.

TypedWritable * PandaNode::make_from_bam ( const FactoryParams params) [static, protected, inherited]

This function is called by the BamReader's factory when a new object of type PandaNode is encountered in the Bam file.

It should create the PandaNode and extract its information from the file.

Reimplemented in AnimBundleNode, Character, CollisionNode, RopeNode, SheetNode, Camera, Fog, GeomNode, LensNode, ModelNode, ModelRoot, PlaneNode, PolylightNode, PortalNode, UvScrollNode, AmbientLight, CallbackNode, DirectionalLight, FadeLODNode, LODNode, PointLight, SequenceNode, Spotlight, SwitchNode, and MouseRecorder.

Definition at line 4310 of file pandaNode.cxx.

References PandaNode::fillin().

Referenced by PandaNode::register_with_read_factory(), and RopeNode::register_with_read_factory().

void TypedWritable::mark_bam_modified ( ) [inline, inherited]
void PandaNode::mark_bounds_stale ( int  pipeline_stage,
Thread current_thread 
) const [inline, protected, inherited]

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.

Definition at line 723 of file pandaNode.I.

void PandaNode::mark_bounds_stale ( Thread current_thread = Thread::get_current_thread()) const [inherited]

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.

With no parameters, this means to iterate through all stages including and upstream of the current pipeline stage.

This method is intended for internal use; usually it is not necessary for a user to call this directly. It will be called automatically by derived classes when appropriate.

Definition at line 2583 of file pandaNode.cxx.

Referenced by PandaNode::adjust_draw_mask(), PandaNode::clear_attrib(), PandaNode::copy_all_properties(), PandaNode::force_bounds_stale(), PandaNode::mark_internal_bounds_stale(), PandaNode::set_attrib(), PandaNode::set_bounds(), PandaNode::set_bounds_type(), PandaNode::set_internal_bounds(), PandaNode::set_into_collide_mask(), PortalNode::set_into_portal_mask(), PandaNode::set_state(), and PandaNode::set_transform().

void PandaNode::mark_internal_bounds_stale ( Thread current_thread = Thread::get_current_thread()) [inherited]
void PandaNode::mark_internal_bounds_stale ( int  pipeline_stage,
Thread current_thread 
) [inline, protected, inherited]

Should be called by a derived class to mark the internal bounding volume stale, so that recompute_internal_bounds() will be called when the bounding volume is next requested.

Definition at line 746 of file pandaNode.I.

References PandaNode::mark_bounds_stale().

LPoint3f PGItem::mouse_to_local ( const LPoint2f mouse_point) const [protected, inherited]

Converts from the 2-d mouse coordinates into the coordinate space of the item.

Definition at line 1272 of file pgItem.cxx.

References TransformState::get_mat(), NodePath::get_transform(), LVector3f::rfu(), and LMatrix4f::xform_point().

void PGItem::move ( const MouseWatcherParameter param) [virtual, inherited]

This is a callback hook function, called whenever a mouse is moved while within the region.

Reimplemented in PGSliderBar.

Definition at line 783 of file pgItem.cxx.

References PGItem::get_notify(), PGItem::has_notify(), and PGItemNotify::item_move().

Referenced by PGMouseWatcherRegion::move().

void PandaNode::output ( ostream &  out) const [virtual, inherited]

Outputs the Namable.

This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.

Reimplemented from Namable.

Reimplemented in CollisionNode, ButtonNode, HermiteCurve, RopeNode, SheetNode, Fog, GeomNode, LensNode, PlaneNode, PolylightNode, PortalNode, CallbackNode, FadeLODNode, LODNode, ForceNode, MouseRecorder, and TextNode.

Definition at line 2329 of file pandaNode.cxx.

Referenced by DriveInterface::force_dgraph(), RopeNode::output(), and HermiteCurve::output().

void PandaNode::parents_changed ( ) [protected, virtual, inherited]

Called after a scene graph update that either adds or remove parents from this node, this just provides a hook for derived PandaNode objects that need to update themselves based on the set of parents the node has.

Reimplemented in DataNode.

Definition at line 2914 of file pandaNode.cxx.

Referenced by PandaNode::add_child(), PandaNode::add_stashed(), PandaNode::remove_child(), and PandaNode::replace_child().

void PGItem::play_sound ( const string &  event) [protected, inherited]
void PandaNode::prepare_scene ( GraphicsStateGuardianBase gsg,
const RenderState net_state 
) [inherited]

Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG.

It is not strictly necessary to call this, since the GSG will initialize itself when the scene is rendered, but this may take some of the overhead away from that process.

In particular, this will ensure that textures within the scene are loaded in texture memory, and display lists are built up from static geometry.

Definition at line 2270 of file pandaNode.cxx.

References Thread::get_current_thread(), and PandaNode::r_prepare_scene().

Referenced by NodePath::prepare_scene().

bool PandaNode::preserve_name ( ) const [virtual, inherited]

Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operation, false otherwise.

Reimplemented in CollisionNode, ModelNode, and PortalNode.

Definition at line 323 of file pandaNode.cxx.

Referenced by SceneGraphReducer::choose_name().

void PGItem::press ( const MouseWatcherParameter param,
bool  background 
) [virtual, inherited]

This is a callback hook function, called whenever a mouse or keyboard button is depressed while the mouse is within the region.

Reimplemented in PGButton, PGEntry, and PGSliderBar.

Definition at line 677 of file pgItem.cxx.

References MouseWatcherParameter::get_button(), PGItem::get_notify(), PGItem::get_press_event(), PGItem::get_repeat_event(), PGItem::has_notify(), MouseWatcherParameter::is_keyrepeat(), PGItemNotify::item_press(), and PGItem::play_sound().

Referenced by PGItem::background_press(), and PGMouseWatcherRegion::press().

void PGVirtualFrame::r_copy_children ( const PandaNode from,
PandaNode::InstanceMap &  inst_map,
Thread current_thread 
) [protected, virtual]

This is called by r_copy_subgraph(); the copy has already been made of this particular node (and this is the copy); this function's job is to copy all of the children from the original.

Note that it includes the parameter inst_map, which is a map type, and is not (and cannot be) exported from PANDA.DLL. Thus, any derivative of PandaNode that is not also a member of PANDA.DLL *cannot* access this map, and probably should not even override this function.

Reimplemented from PandaNode.

Definition at line 95 of file pgVirtualFrame.cxx.

References clear_clip_frame(), get_canvas_node(), get_canvas_parent(), PandaNode::remove_child(), and set_clip_frame().

void PandaNode::r_mark_geom_bounds_stale ( Thread current_thread) [protected, virtual, inherited]
void PGItem::r_prepare_scene ( const RenderState state,
PreparedGraphicsObjects prepared_objects,
Thread current_thread 
) [protected, virtual, inherited]

The recursive implementation of prepare_scene().

Don't call this directly; call PandaNode::prepare_scene() or NodePath::prepare_scene() instead.

Reimplemented from PandaNode.

Definition at line 362 of file pgItem.cxx.

References PandaNode::get_state(), NodePath::is_empty(), NodePath::node(), and PandaNode::r_prepare_scene().

void PGItem::reduce_region ( LVecBase4f frame,
PGItem obscurer 
) const [protected, inherited]

The frame parameter is an in/out parameter.

This function adjusts frame so that it represents the largest part of the rectangular region passed in, that does not overlap with the rectangular region of the indicated obscurer. If the obscurer is NULL, or is a hidden node, it is not considered and the frame is left unchanged.

This is used by slider bars and scroll frames, which have to automatically figure out how much space they have to work with after allowing space for scroll bars and buttons.

Definition at line 1207 of file pgItem.cxx.

References PGItem::get_relative_frame(), and PandaNode::is_overall_hidden().

Referenced by PGSliderBar::recompute().

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 PandaNode::register_with_read_factory ( ) [static, inherited]
void PGItem::release ( const MouseWatcherParameter param,
bool  background 
) [virtual, inherited]

This is a callback hook function, called whenever a mouse or keyboard button previously depressed with press() is released.

Reimplemented in PGButton, and PGSliderBar.

Definition at line 709 of file pgItem.cxx.

References MouseWatcherParameter::get_button(), PGItem::get_notify(), PGItem::get_release_event(), PGItem::has_notify(), PGItemNotify::item_release(), and PGItem::play_sound().

Referenced by PGItem::background_release(), and PGMouseWatcherRegion::release().

void PandaNode::remove_all_children ( Thread current_thread = Thread::get_current_thread()) [inherited]

Removes all the children from the node at once, including stashed children.

This can only be called from the top pipeline stage (i.e. from App).

Definition at line 1062 of file pandaNode.cxx.

References PandaNode::children_changed(), PandaNode::force_bounds_stale(), and TypedWritable::mark_bam_modified().

Referenced by MouseWatcherGroup::clear_regions(), MouseWatcherGroup::do_update_regions(), GeoMipTerrain::generate(), PandaNode::steal_children(), and GeoMipTerrain::update().

bool PandaNode::remove_child ( PandaNode child_node,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Removes the indicated child from the node.

Returns true if the child was removed, false if it was not already a child of the node. This will also successfully remove the child if it had been stashed.

Definition at line 804 of file pandaNode.cxx.

References PandaNode::children_changed(), PandaNode::force_bounds_stale(), and PandaNode::parents_changed().

void PandaNode::remove_child ( int  child_index,
Thread current_thread = Thread::get_current_thread() 
) [inherited]
void LinkedListNode::remove_from_list ( ) [inline, protected, inherited]

Removes a LinkedListNode record from the doubly-linked list.

Definition at line 73 of file linkedListNode.I.

Referenced by SimpleLruPage::dequeue_lru(), SimpleAllocatorBlock::do_free(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

void PandaNode::remove_stashed ( int  child_index,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Removes the nth stashed child from the node.

Definition at line 1028 of file pandaNode.cxx.

References PandaNode::children_changed(), PandaNode::force_bounds_stale(), Thread::get_pipeline_stage(), and TypedWritable::mark_bam_modified().

Referenced by PandaNode::unstash_child().

bool PandaNode::replace_child ( PandaNode orig_child,
PandaNode new_child,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead.

Returns true if the replacement is made, or false if the node is not a child or if there is some other problem.

Definition at line 843 of file pandaNode.cxx.

References PandaNode::children_changed(), and PandaNode::parents_changed().

Referenced by SceneGraphReducer::r_apply_attribs(), and PandaNode::replace_node().

void PandaNode::replace_node ( PandaNode other) [inherited]

Inserts this node into the scene graph in place of the other one, and removes the other node.

All scene graph attributes (TransformState, RenderState, etc.) are copied to this node.

All children are moved to this node, and removed from the old node. The new node is left in the same place in the old node's parent's list of children.

Even NodePaths that reference the old node are updated in-place to reference the new node instead.

This method is intended to be used to replace a node of a given type in the scene graph with a node of a different type.

Definition at line 1917 of file pandaNode.cxx.

References PandaNode::copy_all_properties(), PandaNode::find_parent(), Thread::get_current_thread(), PandaNode::Parents::get_num_parents(), PandaNode::Parents::get_parent(), PandaNode::get_parents(), PandaNode::remove_child(), PandaNode::replace_child(), and PandaNode::steal_children().

Referenced by SceneGraphReducer::do_flatten_siblings().

bool TypedWritable::require_fully_complete ( ) const [virtual, inherited]

Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.

If this is the case, override this method to return true, and be careful with circular references (which would make the object unreadable from a bam file).

Reimplemented in GeomVertexData, ClipPlaneAttrib, and RenderEffects.

Definition at line 118 of file typedWritable.cxx.

void PandaNode::reset_all_prev_transform ( Thread current_thread = Thread::get_current_thread()) [static, inherited]

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.

Definition at line 1425 of file pandaNode.cxx.

References Thread::get_pipeline_stage(), and TypedWritable::mark_bam_modified().

void PandaNode::reset_prev_transform ( Thread current_thread = Thread::get_current_thread()) [inherited]
bool PandaNode::safe_to_combine ( ) const [virtual, inherited]

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.

For instance, an LODNode should not be combined with any other PandaNode, because its set of children is meaningful.

Reimplemented in GeomNode, ModelNode, UvScrollNode, CallbackNode, LODNode, SequenceNode, and SwitchNode.

Definition at line 285 of file pandaNode.cxx.

Referenced by SceneGraphReducer::consider_child(), and SceneGraphReducer::flatten_siblings().

bool PandaNode::safe_to_combine_children ( ) const [virtual, inherited]

Returns true if it is generally safe to combine the children of this PandaNode with each other.

For instance, an LODNode's children should not be combined with each other, because the set of children is meaningful.

Reimplemented in LODNode, SequenceNode, and SwitchNode.

Definition at line 299 of file pandaNode.cxx.

Referenced by SceneGraphReducer::flatten(), and SceneGraphReducer::r_flatten().

bool PandaNode::safe_to_flatten ( ) const [virtual, inherited]

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

Reimplemented in AnimBundleNode, ParametricCurve, Camera, GeomNode, ModelNode, UvScrollNode, ForceNode, and PhysicalNode.

Definition at line 241 of file pandaNode.cxx.

Referenced by SceneGraphReducer::r_apply_attribs().

bool PandaNode::safe_to_flatten_below ( ) const [virtual, inherited]

Returns true if a flatten operation may safely continue past this node, or false if nodes below this node may not be molested.

Reimplemented in ModelNode.

Definition at line 311 of file pandaNode.cxx.

Referenced by SceneGraphReducer::r_apply_attribs(), and SceneGraphReducer::r_flatten().

bool PandaNode::safe_to_modify_transform ( ) const [virtual, inherited]

Returns true if it is safe to automatically adjust the transform on this kind of node.

Usually, this is only a bad idea if the user expects to find a particular transform on the node.

ModelNodes with the preserve_transform flag set are presently the only kinds of nodes that should not have their transform even adjusted.

Reimplemented in ModelNode.

Definition at line 270 of file pandaNode.cxx.

Referenced by SceneGraphReducer::r_apply_attribs().

bool PandaNode::safe_to_transform ( ) const [virtual, inherited]

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

Reimplemented in ParametricCurve, RopeNode, SheetNode, Camera, and ModelNode.

Definition at line 253 of file pandaNode.cxx.

Referenced by SceneGraphReducer::r_apply_attribs().

void PGItem::set_active ( bool  active) [virtual, inherited]

Sets whether the PGItem is active for mouse watching.

This is not necessarily related to the active/inactive appearance of the item, which is controlled by set_state(), but it does affect whether it responds to mouse events.

Reimplemented in PGButton, PGEntry, and PGSliderBar.

Definition at line 873 of file pgItem.cxx.

References PGItem::get_focus(), and PGItem::set_focus().

void PandaNode::set_attrib ( const RenderAttrib attrib,
int  override = 0 
) [inherited]

Adds the indicated render attribute to the scene graph on this node.

This attribute will now apply to this node and everything below. If there was already an attribute of the same type, it is replaced.

Definition at line 1179 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), PandaNode::mark_bounds_stale(), and PandaNode::state_changed().

Referenced by AccumulatedAttribs::apply_to_node(), NodePath::clear_clip_plane(), NodePath::clear_light(), NodePath::clear_tex_gen(), NodePath::clear_tex_transform(), NodePath::clear_texture(), NodePath::compose_color_scale(), WindowFramework::get_render(), NodePath::set_all_color_scale(), NodePath::set_alpha_scale(), NodePath::set_antialias(), NodePath::set_attrib(), NodePath::set_audio_volume(), NodePath::set_audio_volume_off(), NodePath::set_bin(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_color(), NodePath::set_color_off(), NodePath::set_color_scale(), NodePath::set_color_scale_off(), NodePath::set_depth_offset(), NodePath::set_depth_test(), NodePath::set_depth_write(), NodePath::set_fog(), NodePath::set_fog_off(), NodePath::set_instance_count(), NodePath::set_light(), NodePath::set_light_off(), NodePath::set_material(), NodePath::set_material_off(), WindowFramework::set_one_sided_reverse(), NodePath::set_render_mode(), NodePath::set_render_mode_filled(), NodePath::set_render_mode_perspective(), NodePath::set_render_mode_thickness(), NodePath::set_render_mode_wireframe(), NodePath::set_tex_gen(), NodePath::set_tex_transform(), NodePath::set_texture(), NodePath::set_texture_off(), NodePath::set_transparency(), NodePath::set_two_sided(), WindowFramework::set_wireframe(), SceneGraphAnalyzerMeter::setup_window(), and FrameRateMeter::setup_window().

void PGItem::set_background_focus ( bool  focus) [inherited]

Sets the background_focus flag for this item.

When background_focus is enabled, the item will receive keypress events even if it is not in focus; in fact, even if it is not onscreen. Unlike normal focus, many items may have background_focus simultaneously.

Definition at line 945 of file pgItem.cxx.

References PGItem::get_background_focus().

void PandaNode::set_bound ( const BoundingVolume volume) [inherited]

Deprecated.

Use set_bounds() instead.

Definition at line 2465 of file pandaNode.cxx.

References PandaNode::set_bounds().

void PandaNode::set_bounds ( const BoundingVolume volume) [inherited]

Resets the bounding volume so that it is the indicated volume.

When it is explicitly set, the bounding volume will no longer be automatically computed according to the contents of the node itself, for nodes like GeomNodes and TextNodes that contain substance (but the bounding volume will still be automatically expanded to include its children).

Call clear_bounds() if you would like to return the bounding volume to its default behavior later.

Definition at line 2444 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), and PandaNode::mark_bounds_stale().

Referenced by PandaNode::clear_bounds(), and PandaNode::set_bound().

void PandaNode::set_bounds_type ( BoundingVolume::BoundsType  bounds_type) [inherited]

Specifies the desired type of bounding volume that will be created for this node.

This is normally BoundingVolume::BT_default, which means to set the type according to the config variable "bounds-type".

If this is BT_sphere or BT_box, a BoundingSphere or BoundingBox is explicitly created. If it is BT_best, the appropriate type to best enclose the node's children is created.

This affects the bounding volume returned by get_bounds(), which is not exactly the same bounding volume modified by set_bounds(), because a new bounding volume has to be created that includes this node and all of its children.

Definition at line 2401 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), PandaNode::mark_bounds_stale(), and PandaNode::mark_internal_bounds_stale().

void PGVirtualFrame::set_canvas_transform ( const TransformState transform) [inline]

Changes the transform of the virtual canvas.

This transform is applied to all child nodes of the canvas_node.

Definition at line 65 of file pgVirtualFrame.I.

void PGVirtualFrame::set_clip_frame ( const LVecBase4f frame)

Sets the bounding rectangle of the clip frame.

This is the size of the small window through which we can see the virtual canvas. Normally, this is the same size as the actual frame or smaller (typically it is smaller by the size of the bevel, or to make room for scroll bars).

Definition at line 164 of file pgVirtualFrame.cxx.

References clip_frame_changed().

void PGVirtualFrame::set_clip_frame ( float  left,
float  right,
float  bottom,
float  top 
) [inline]

Sets the bounding rectangle of the clip frame.

This is the size of the small window through which we can see the virtual canvas. Normally, this is the same size as the actual frame or smaller (typically it is smaller by the size of the bevel, or to make room for scroll bars).

Definition at line 27 of file pgVirtualFrame.I.

Referenced by r_copy_children(), setup(), and PGScrollFrame::setup().

void PandaNode::set_cull_callback ( ) [protected, inherited]

Intended to be called in the constructor by any subclass that defines cull_callback(), this sets up the flags to indicate that the cullback needs to be called.

Definition at line 3080 of file pandaNode.cxx.

References Thread::get_current_thread(), and TypedWritable::mark_bam_modified().

Referenced by Character::Character(), CallbackNode::clear_cull_callback(), and PortalNode::PortalNode().

void PandaNode::set_effect ( const RenderEffect effect) [inherited]
void PandaNode::set_effects ( const RenderEffects effects,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Sets the complete RenderEffects that will be applied this node.

This completely replaces whatever has been set on this node via repeated calls to set_attrib().

Definition at line 1319 of file pandaNode.cxx.

References RenderEffects::is_empty(), and TypedWritable::mark_bam_modified().

Referenced by PandaNode::clear_effects(), and NodePath::set_effects().

void PandaNode::set_final ( bool  flag) [inline, inherited]

Sets the "final" flag on this PandaNode.

If this is true, than no bounding volume need be tested below it; a positive intersection with this node's bounding volume is deemed to be a positive intersection with all geometry inside.

This is useful to quickly force a larger bounding volume around a node when the GeomNodes themselves are inaccurate for some reason, without forcing a recompute of every nested bounding volume. It's also helpful when the bounding volume is tricked by some special properties, like billboards, that may move geometry out of its bounding volume otherwise.

Definition at line 663 of file pandaNode.I.

References TypedWritable::mark_bam_modified().

void PGItem::set_focus ( bool  focus) [virtual, inherited]

Sets whether the PGItem currently has keyboard focus.

This simply means that the item may respond to keyboard events as well as to mouse events; precisely what this means is up to the individual item.

Only one PGItem in the world is allowed to have focus at any given time. Setting the focus on any other item automatically disables the focus from the previous item.

Reimplemented in PGEntry.

Definition at line 900 of file pgItem.cxx.

References PGItem::focus_in(), PGItem::focus_out(), PGItem::get_active(), PGItem::get_focus(), and PGItem::set_focus().

Referenced by PGItem::set_active(), and PGItem::set_focus().

void PGItem::set_frame ( float  left,
float  right,
float  bottom,
float  top 
) [inline, inherited]

Sets the bounding rectangle of the item, in local coordinates.

This is the region on screen within which the mouse will be considered to be within the item. Normally, it should correspond to the bounding rectangle of the visible geometry of the item.

Definition at line 100 of file pgItem.I.

Referenced by PGWaitBar::setup(), setup(), PGScrollFrame::setup(), PGEntry::setup(), PGButton::setup(), PGSliderBar::setup_scroll_bar(), and PGSliderBar::setup_slider().

void PGItem::set_frame ( const LVecBase4f frame) [inline, inherited]

Sets the bounding rectangle of the item, in local coordinates.

This is the region on screen within which the mouse will be considered to be within the item. Normally, it should correspond to the bounding rectangle of the visible geometry of the item.

Definition at line 114 of file pgItem.I.

References PGItem::frame_changed().

void PGItem::set_frame_style ( int  state,
const PGFrameStyle style 
) [inherited]

Changes the kind of frame that will be drawn behind the item when it is in the indicated state.

Definition at line 1085 of file pgItem.cxx.

References PGItem::get_state_def(), NodePath::is_empty(), and PandaNode::mark_internal_bounds_stale().

Referenced by PGWaitBar::setup(), setup(), PGScrollFrame::setup(), PGEntry::setup(), PGButton::setup(), PGSliderBar::setup_scroll_bar(), and PGSliderBar::setup_slider().

void PGItem::set_id ( const string &  id) [inline, inherited]

Set the unique ID assigned to this PGItem.

It is the user's responsibility to ensure that this ID is unique.

Normally, this should not need to be called, as the PGItem will assign itself an ID when it is created, but this function allows the user to decide to redefine the ID to be something possibly more meaningful.

Definition at line 282 of file pgItem.I.

void PandaNode::set_internal_bounds ( const BoundingVolume volume) [protected, inherited]

This is provided as an alternate way for a node to set its own internal bounds, rather than overloading compute_internal_bounds().

If this method is called, the internal bounding volume will immediately be set to the indicated pointer.

Definition at line 2799 of file pandaNode.cxx.

References Thread::get_current_thread(), TypedWritable::mark_bam_modified(), and PandaNode::mark_bounds_stale().

void PandaNode::set_into_collide_mask ( CollideMask  mask) [inherited]

Sets the "into" CollideMask.

This specifies the set of bits that must be shared with a CollisionNode's "from" CollideMask in order for the CollisionNode to detect a collision with this particular node.

The actual CollideMask that will be set is masked by the return value from get_legal_collide_mask(). Thus, the into_collide_mask cannot be set to anything other than nonzero except for those types of nodes that can be collided into, such as CollisionNodes and GeomNodes.

Reimplemented in CollisionNode.

Definition at line 2177 of file pandaNode.cxx.

References Thread::get_current_thread(), PandaNode::get_legal_collide_mask(), TypedWritable::mark_bam_modified(), and PandaNode::mark_bounds_stale().

void PGItem::set_notify ( PGItemNotify notify) [inline, inherited]

Sets the object which will be notified when the PGItem changes.

Set this to NULL to disable this effect. The PGItem does not retain ownership of the pointer; it is your responsibility to ensure that the notify object does not destruct.

Definition at line 54 of file pgItem.I.

References PGItemNotify::add_item(), and PGItemNotify::remove_item().

void PandaNode::set_overall_hidden ( bool  hidden) [inline, inherited]

Sets or clears the hidden flag.

When the hidden flag is true, the node and all of its children are invisible to all cameras, regardless of the setting of any draw masks. Setting the hidden flag to false restores the previous visibility as established by the draw masks.

This actually works by twiddling the reserved _overall_bit in the node's draw mask, which has special meaning.

Definition at line 544 of file pandaNode.I.

References PandaNode::adjust_draw_mask(), and BitMask< PN_uint32, 32 >::all_off().

void PandaNode::set_prev_transform ( const TransformState transform,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations.

Definition at line 1375 of file pandaNode.cxx.

References TypedWritable::mark_bam_modified().

Referenced by AccumulatedAttribs::collect(), and NodePath::set_prev_transform().

void PandaNode::set_scene_root_func ( SceneRootFunc *  func) [static, inherited]

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.

This back-pointer is necessary because we can't make calls directly into GraphicsEngine, which is in the display module.

Definition at line 4238 of file pandaNode.cxx.

void PandaNode::set_state ( const RenderState state,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Sets the complete RenderState that will be applied to all nodes at this level and below.

(The actual state that will be applied to lower nodes is based on the composition of RenderStates from above this node as well). This completely replaces whatever has been set on this node via repeated calls to set_attrib().

Definition at line 1288 of file pandaNode.cxx.

References RenderState::is_empty(), TypedWritable::mark_bam_modified(), PandaNode::mark_bounds_stale(), and PandaNode::state_changed().

Referenced by AccumulatedAttribs::apply_to_node(), PandaNode::clear_state(), AccumulatedAttribs::collect(), MultitexReducer::scan(), and NodePath::set_state().

void PGItem::set_state ( int  state) [inline, inherited]

Sets the "state" of this particular PGItem.

The PGItem node will render as if it were the subgraph assigned to the corresponding index via set_state_def().

Definition at line 175 of file pgItem.I.

Referenced by PGButton::enter_region(), PGButton::exit_region(), PGButton::press(), PGButton::release(), PGButton::set_active(), PGWaitBar::setup(), setup(), PGScrollFrame::setup(), PGSliderBar::setup_scroll_bar(), and PGSliderBar::setup_slider().

void PGItem::set_suppress_flags ( int  suppress_flags) [inline, inherited]

This is just an interface to set the suppress flags on the underlying MouseWatcherRegion.

See MouseWatcherRegion::set_suppress_flags().

Definition at line 236 of file pgItem.I.

void PandaNode::set_tag ( const string &  key,
const string &  value,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Associates a user-defined value with a user-defined key which is stored on the node.

This value has no meaning to Panda; but it is stored indefinitely on the node until it is requested again.

Each unique key stores a different string value. There is no effective limit on the number of different keys that may be stored or on the length of any one key's value.

Definition at line 1466 of file pandaNode.cxx.

References TypedWritable::mark_bam_modified().

Referenced by NodePath::set_tag().

void PGItem::set_text_node ( TextNode node) [inline, static, inherited]

Changes the TextNode object that will be used by all PGItems to generate default labels given a string.

This can be loaded with the default font, etc.

Definition at line 560 of file pgItem.I.

void PandaNode::set_transform ( const TransformState transform,
Thread current_thread = Thread::get_current_thread() 
) [inherited]
void PandaNode::set_unexpected_change ( unsigned int  flags) [inherited]

Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node.

Once one of these bits has been set, if the property changes, an assertion failure will be raised, which is designed to assist the developer in identifying the troublesome code that modified the property unexpectedly.

The input parameter is the union of bits that are to be set. To clear these bits later, use clear_unexpected_change().

Since this is a developer debugging tool only, this function does nothing in a production (NDEBUG) build.

Definition at line 1983 of file pandaNode.cxx.

void PGVirtualFrame::setup ( float  width,
float  height 
)
bool PandaNode::stash_child ( PandaNode child_node,
Thread current_thread = Thread::get_current_thread() 
) [inline, inherited]

Stashes the indicated child node.

This removes the child from the list of active children and puts it on a special list of stashed children. This child node no longer contributes to the bounding volume of the PandaNode, and is not visited in normal traversals. It is invisible and uncollidable. The child may later be restored by calling unstash_child().

This function returns true if the child node was successfully stashed, or false if it was not a child of the node in the first place (e.g. it was previously stashed).

Definition at line 133 of file pandaNode.I.

References PandaNode::find_child().

void PandaNode::stash_child ( int  child_index,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Stashes the indicated child node.

This removes the child from the list of active children and puts it on a special list of stashed children. This child node no longer contributes to the bounding volume of the PandaNode, and is not visited in normal traversals. It is invisible and uncollidable. The child may later be restored by calling unstash_child().

This can only be called from the top pipeline stage (i.e. from App).

Definition at line 898 of file pandaNode.cxx.

References PandaNode::children_changed(), PandaNode::force_bounds_stale(), PandaNode::get_child(), PandaNode::get_child_sort(), PandaNode::get_num_children(), Thread::get_pipeline_stage(), TypedWritable::mark_bam_modified(), and PandaNode::remove_child().

void PandaNode::state_changed ( ) [protected, virtual, inherited]

Called after the node's RenderState has been changed for any reason, this just provides a hook so derived classes can do something special in this case.

Definition at line 2952 of file pandaNode.cxx.

Referenced by PandaNode::clear_attrib(), PandaNode::copy_all_properties(), PandaNode::set_attrib(), and PandaNode::set_state().

void PandaNode::steal_children ( PandaNode other,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Moves all the children from the other node onto this node.

Any NodePaths to child nodes of the other node are truncated, rather than moved to the new parent.

Definition at line 1110 of file pandaNode.cxx.

References PandaNode::add_child(), PandaNode::add_stashed(), PandaNode::get_child(), PandaNode::get_child_sort(), PandaNode::get_num_children(), PandaNode::get_num_stashed(), PandaNode::get_stashed(), PandaNode::get_stashed_sort(), and PandaNode::remove_all_children().

Referenced by PandaNode::replace_node().

void LinkedListNode::take_list_from ( LinkedListNode other_root) [inline, protected, inherited]

Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.

Definition at line 127 of file linkedListNode.I.

Referenced by BufferContextChain::take_from().

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
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().

void PGItem::transform_changed ( ) [protected, virtual, inherited]

Called after the node's transform has been changed for any reason, this just provides a hook so derived classes can do something special in this case.

Reimplemented from PandaNode.

Definition at line 160 of file pgItem.cxx.

References PGItem::get_notify(), PGItem::has_notify(), and PGItemNotify::item_transform_changed().

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().

bool PandaNode::unstash_child ( PandaNode child_node,
Thread current_thread = Thread::get_current_thread() 
) [inline, inherited]

Returns the indicated stashed node to normal child status.

This removes the child from the list of stashed children and puts it on the normal list of active children. This child node once again contributes to the bounding volume of the PandaNode, and will be visited in normal traversals. It is visible and collidable.

This function returns true if the child node was successfully stashed, or false if it was not a child of the node in the first place (e.g. it was previously stashed).

Definition at line 159 of file pandaNode.I.

References PandaNode::find_stashed().

void PandaNode::unstash_child ( int  stashed_index,
Thread current_thread = Thread::get_current_thread() 
) [inherited]

Returns the indicated stashed node to normal child status.

This removes the child from the list of stashed children and puts it on the normal list of active children. This child node once again contributes to the bounding volume of the PandaNode, and will be visited in normal traversals. It is visible and collidable.

This can only be called from the top pipeline stage (i.e. from App).

Definition at line 943 of file pandaNode.cxx.

References PandaNode::children_changed(), PandaNode::force_bounds_stale(), PandaNode::get_num_stashed(), Thread::get_pipeline_stage(), PandaNode::get_stashed(), PandaNode::get_stashed_sort(), TypedWritable::mark_bam_modified(), and PandaNode::remove_stashed().

void PandaNode::update_bam_nested ( BamWriter manager) [virtual, inherited]

Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.

Reimplemented from TypedWritable.

Definition at line 4275 of file pandaNode.cxx.

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().

void PGItem::within_region ( const MouseWatcherParameter param) [virtual, inherited]

This is a callback hook function, called whenever the mouse moves within the boundaries of the region, even if it is also within the boundaries of a nested region.

This is different from "enter", which is only called whenever the mouse is within only that region.

Definition at line 581 of file pgItem.cxx.

References PGItem::get_notify(), PGItem::get_within_event(), PGItem::has_notify(), PGItemNotify::item_within(), and PGItem::play_sound().

Referenced by PGMouseWatcherRegion::within_region().

void PGItem::without_region ( const MouseWatcherParameter param) [virtual, inherited]

This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region.

See within().

Definition at line 606 of file pgItem.cxx.

References PGItem::get_notify(), PGItem::get_without_event(), PGItem::has_notify(), PGItemNotify::item_without(), and PGItem::play_sound().

Referenced by PGMouseWatcherRegion::without_region().

void PandaNode::write_datagram ( BamWriter manager,
Datagram dg 
) [virtual, inherited]
void PandaNode::write_recorder ( BamWriter manager,
Datagram dg 
) [inherited]

This method is provided for the benefit of classes (like MouseRecorder) that inherit from PandaMode and also RecorderBase.

It's not virtual at this level since it doesn't need to be (it's called up from the derived class).

This method acts very like write_datagram, but it writes the node as appropriate for writing a RecorderBase object as described in the beginning of a session file, meaning it doesn't need to write things such as children. It balances with fillin_recorder().

Reimplemented in MouseRecorder.

Definition at line 4297 of file pandaNode.cxx.

References Datagram::add_string().

void PGItem::xform ( const LMatrix4f mat) [virtual, inherited]

Transforms the contents of this node by the indicated matrix, if it means anything to do so.

For most kinds of nodes, this does nothing.

Reimplemented from PandaNode.

Reimplemented in PGEntry, PGScrollFrame, and PGSliderBar.

Definition at line 387 of file pgItem.cxx.

References SceneGraphReducer::apply_attribs(), NodePath::get_transform(), PandaNode::mark_internal_bounds_stale(), NodePath::node(), and NodePath::set_transform().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations