PGScrollFrame

Inheritance:

Methods of PGScrollFrame:

Methods of PGVirtualFrame:

Methods of PGItem:

Methods of PandaNode:

Methods of TypedWritable:

Methods of TypedObject:

Methods of Namable:

Methods of BoundedObject:

Methods of ReferenceCount:

clearHorizontalSlider
void PGScrollFrame::clear_horizontal_slider(void);

Description: Removes the horizontal scroll bar from control of the frame. It is your responsibility to actually remove or hide the object itself.

clearVerticalSlider
void PGScrollFrame::clear_vertical_slider(void);

Description: Removes the vertical scroll bar from control of the frame. It is your responsibility to actually remove or hide the object itself.

clearVirtualFrame
void PGScrollFrame::clear_virtual_frame(void);

Description: Removes the virtual frame from the item. This effectively sets the virtual frame to the same size as the clip frame. Scrolling will no longer be possible.

getAutoHide
bool PGScrollFrame::get_auto_hide(void) const;

Description: Returns the auto_hide flag. See set_auto_hide().

getClassType
static TypeHandle PGScrollFrame::get_class_type(void);

Undocumented function.

getHorizontalSlider
PGSliderBar *PGScrollFrame::get_horizontal_slider(void) const;

Description: Returns the PGSliderBar that serves as the horizontal scroll bar for this frame, if any, or NULL if it is not set.

getManagePieces
bool PGScrollFrame::get_manage_pieces(void) const;

Description: Returns the manage_pieces flag. See set_manage_pieces().

getVerticalSlider
PGSliderBar *PGScrollFrame::get_vertical_slider(void) const;

Description: Returns the PGSliderBar that serves as the vertical scroll bar for this frame, if any, or NULL if it is not set.

getVirtualFrame
LVecBase4f const &PGScrollFrame::get_virtual_frame(void) const;

Description: Returns the bounding rectangle of the virtual frame. See set_virtual_frame(). If has_virtual_frame() is false, this returns the item's clip frame.

hasVirtualFrame
bool PGScrollFrame::has_virtual_frame(void) const;

Description: Returns true if the virtual frame has a bounding rectangle; see set_virtual_frame(). Most PGScrollFrame objects will have a virtual frame.

recompute
void PGScrollFrame::recompute(void);

Description: Forces the PGScrollFrame to recompute itself right now. Normally this should not be required.

remanage
void PGScrollFrame::remanage(void);

Description: Manages the position and size of the scroll bars. Normally this should not need to be called directly.

setAutoHide
void PGScrollFrame::set_auto_hide(bool auto_hide);

Description: Sets the auto_hide flag. When this is true, the two scroll bars are automatically hidden if they are not needed (that is, if the virtual frame would fit within the clip frame without them), and they are automatically shown when they are needed.
Setting this flag true forces the manage_pieces flag to also be set true.

setHorizontalSlider
void PGScrollFrame::set_horizontal_slider(PGSliderBar *horizontal_slider);

Description: Sets the PGSliderBar object that will serve as the horizontal scroll bar for this frame. It is your responsibility to parent this slider bar to the frame and move it to the appropriate place.

setManagePieces
void PGScrollFrame::set_manage_pieces(bool manage_pieces);

Description: Sets the manage_pieces flag. When this is true, the sub-pieces of the scroll frame--that is, the two scroll bars--are automatically positioned and/or resized when the scroll frame's overall frame is changed. They are also automatically resized to fill in the gap when one or the other is hidden.

setVerticalSlider
void PGScrollFrame::set_vertical_slider(PGSliderBar *vertical_slider);

Description: Sets the PGSliderBar object that will serve as the vertical scroll bar for this frame. It is your responsibility to parent this slider bar to the frame and move it to the appropriate place.

setVirtualFrame
void PGScrollFrame::set_virtual_frame(float left, float right, float bottom, float top);

Filename: pgScrollFrame.I Created by: drose (17Aug05)
PANDA 3D SOFTWARE Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved
All use of this software is subject to the terms of the Panda 3d Software license. You should have received a copy of this license along with this source code; you will also find a current copy of the license at http://etc.cmu.edu/panda3d/docs/license/ .
To contact the maintainers of this program write to panda3d-general@lists.sourceforge.net .
Description: Sets the bounding rectangle of the virtual frame. This is the size of the large, virtual canvas which we can see only a portion of at any given time.

setup
void PGScrollFrame::setup(float width, float height, float left, float right, float bottom, float top, float slider_width, float bevel);

Description: Creates a PGScrollFrame with the indicated dimensions, and the indicated virtual frame.

clearClipFrame
void PGVirtualFrame::clear_clip_frame(void);

Description: Removes the clip frame from the item. This disables clipping.

getCanvasNode
PandaNode *PGVirtualFrame::get_canvas_node(void) const;

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

getCanvasTransform
TransformState const *PGVirtualFrame::get_canvas_transform(void) const;

Description: Returns the transform of the virtual canvas. This transform is applied to all child nodes of the canvas_node.

getClassType
static TypeHandle PGVirtualFrame::get_class_type(void);

Undocumented function.

getClipFrame
LVecBase4f const &PGVirtualFrame::get_clip_frame(void) const;

Description: 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.

getClipPlaneNode
PandaNode *PGVirtualFrame::get_clip_plane_node(void) const;

Description: Returns the special node that holds all of PlaneNodes that are used for applying the clip planes to the canvas_node.

hasClipFrame
bool PGVirtualFrame::has_clip_frame(void) const;

Description: 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.

setCanvasTransform
void PGVirtualFrame::set_canvas_transform(TransformState const *transform);

Description: Changes the transform of the virtual canvas. This transform is applied to all child nodes of the canvas_node.

setClipFrame
void PGVirtualFrame::set_clip_frame(float left, float right, float bottom, float top);

Filename: pgVirtualFrame.I Created by: drose (17Aug05)
PANDA 3D SOFTWARE Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved
All use of this software is subject to the terms of the Panda 3d Software license. You should have received a copy of this license along with this source code; you will also find a current copy of the license at http://etc.cmu.edu/panda3d/docs/license/ .
To contact the maintainers of this program write to panda3d-general@lists.sourceforge.net .
Description: 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).

setup
void PGVirtualFrame::setup(float width, float height);

Description: Creates a PGVirtualFrame with the indicated dimensions.

clearFrame
void PGItem::clear_frame(void);

Description: Removes the bounding rectangle from the item. It will no longer be possible to position the mouse within the item; see set_frame().

clearSound
void PGItem::clear_sound(string const &event);

Description: Removes the sound associated with the indicated event.

clearStateDef
void PGItem::clear_state_def(int state);

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

getActive
bool PGItem::get_active(void) const;

Description: Returns whether the PGItem is currently active for mouse events. See set_active().

getBackgroundFocus
bool PGItem::get_background_focus(void) const;

Description: Returns whether background_focus is currently enabled. See set_background_focus().

getClassType
static TypeHandle PGItem::get_class_type(void);

Undocumented function.

getEnterEvent
string PGItem::get_enter_event(void) const;

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

getEnterPrefix
static string PGItem::get_enter_prefix(void);

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

getExitEvent
string PGItem::get_exit_event(void) const;

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

getExitPrefix
static string PGItem::get_exit_prefix(void);

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

getFocus
bool PGItem::get_focus(void) const;

Description: Returns whether the PGItem currently has focus for keyboard events. See set_focus().

getFocusInEvent
string PGItem::get_focus_in_event(void) const;

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

getFocusInPrefix
static string PGItem::get_focus_in_prefix(void);

Description: 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.

getFocusItem
static PGItem *PGItem::get_focus_item(void);

Description: 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.

getFocusOutEvent
string PGItem::get_focus_out_event(void) const;

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

getFocusOutPrefix
static string PGItem::get_focus_out_prefix(void);

Description: 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.

getFrame
LVecBase4f const &PGItem::get_frame(void) const;

Description: Returns the bounding rectangle of the item. See set_frame(). It is an error to call this if has_frame() returns false.

getFrameInvXform
LMatrix4f PGItem::get_frame_inv_xform(void) const;

Description: Returns the inverse of the frame transform matrix

getFrameStyle
PGFrameStyle PGItem::get_frame_style(int state);

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

getId
string const &PGItem::get_id(void) const;

Description: Returns the unique ID assigned to this PGItem. This will be assigned to the region created with the MouseWatcher, and will thus be used to generate event names.

getKeystrokeEvent
string PGItem::get_keystroke_event(void) const;

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

getKeystrokePrefix
static string PGItem::get_keystroke_prefix(void);

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

getNumStateDefs
int PGItem::get_num_state_defs(void) const;

Description: 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.

getPressEvent
string PGItem::get_press_event(ButtonHandle const &button) const;

Description: 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.

getPressPrefix
static string PGItem::get_press_prefix(void);

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

getReleaseEvent
string PGItem::get_release_event(ButtonHandle const &button) const;

Description: 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.

getReleasePrefix
static string PGItem::get_release_prefix(void);

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

getSound
AudioSound *PGItem::get_sound(string const &event) const;

Description: Returns the sound associated with the indicated event, or NULL if there is no associated sound.

getState
int PGItem::get_state(void) const;

Description: Returns the "state" of this particular PGItem. See set_state().

getStateDef
NodePath &PGItem::get_state_def(int state);

Description: 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.

getSuppressFlags
int PGItem::get_suppress_flags(void) const;

Description: This is just an interface to get the suppress flags on the underlying MouseWatcherRegion. See MouseWatcherRegion::get_suppress_flags().

getTextNode
static TextNode *PGItem::get_text_node(void);

HAVE_AUDIO
Description: 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.

getWithinEvent
string PGItem::get_within_event(void) const;

Description: 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.

getWithinPrefix
static string PGItem::get_within_prefix(void);

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

getWithoutEvent
string PGItem::get_without_event(void) const;

Description: 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.

getWithoutPrefix
static string PGItem::get_without_prefix(void);

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

hasFrame
bool PGItem::has_frame(void) const;

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

hasSound
bool PGItem::has_sound(string const &event) const;

Description: Returns true if there is a sound associated with the indicated event, or false otherwise.

hasStateDef
bool PGItem::has_state_def(int state) const;

Description: 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.

instanceToStateDef
NodePath PGItem::instance_to_state_def(int state, NodePath const &path);

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

setActive
virtual void PGItem::set_active(bool active);

Description: 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.

setBackgroundFocus
void PGItem::set_background_focus(bool focus);

Description: 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.

setFocus
virtual void PGItem::set_focus(bool focus);

Description: 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.

setFrame
void PGItem::set_frame(float left, float right, float bottom, float top);

Description: 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.

setFrameStyle
void PGItem::set_frame_style(int state, PGFrameStyle const &style);

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

setId
void PGItem::set_id(string const &id);

Description: 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.

setSound
void PGItem::set_sound(string const &event, AudioSound *sound);

Description: Sets the sound that will be played whenever the indicated event occurs.

setState
void PGItem::set_state(int state);

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

setSuppressFlags
void PGItem::set_suppress_flags(int suppress_flags);

Description: This is just an interface to set the suppress flags on the underlying MouseWatcherRegion. See MouseWatcherRegion::set_suppress_flags().

setTextNode
static void PGItem::set_text_node(TextNode *node);

Description: 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.

addChild
void PandaNode::add_child(PandaNode *child_node, int sort = (0));

Description: 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.

addStashed
void PandaNode::add_stashed(PandaNode *child_node, int sort = (0));

Description: 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.

asLight
virtual Light *PandaNode::as_light(void);

Description: 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.

clearAttrib
void PandaNode::clear_attrib(TypeHandle type);

Description: 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.

clearEffect
void PandaNode::clear_effect(TypeHandle type);

Description: Removes the render effect of the given type from this node.

clearEffects
void PandaNode::clear_effects(void);

Description: Resets this node to have no render effects.

clearPythonTag
void PandaNode::clear_python_tag(string const &key);

Description: Removes the Python object defined for this key on this particular node. After a call to clear_python_tag(), has_python_tag() will return false for the indicated key.

clearState
void PandaNode::clear_state(void);

Description: 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.

clearTag
void PandaNode::clear_tag(string const &key);

Description: 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.

clearTransform
void PandaNode::clear_transform(void);

Description: Resets the transform on this node to the identity transform.

copyChildren
void PandaNode::copy_children(PandaNode *other);

Description: Makes another instance of all the children of the other node, copying them to this node.

copySubgraph
PointerTo< PandaNode > PandaNode::copy_subgraph(void) const;

Description: Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode. Some data may still be shared from the original (e.g. vertex index tables), but nothing that will impede normal use of the PandaNode.

copyTags
void PandaNode::copy_tags(PandaNode *other);

HAVE_PYTHON
Description: 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.

findChild
int PandaNode::find_child(PandaNode *node) const;

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

findParent
int PandaNode::find_parent(PandaNode *node) const;

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

findStashed
int PandaNode::find_stashed(PandaNode *node) const;

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

getAttrib
RenderAttrib const *PandaNode::get_attrib(TypeHandle type) const;

Description: 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.

getBound
BoundingVolume const &PandaNode::get_bound(void) const;

Description: Returns the node's external bounding volume. This is the bounding volume around the node and all of its children.

getChild
PandaNode *PandaNode::get_child(int n) const;

Description: Returns the nth child node of this node. See get_num_children().

getChildSort
int PandaNode::get_child_sort(int n) const;

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

getClassType
static TypeHandle PandaNode::get_class_type(void);

Undocumented function.

getDrawMask
BitMask< unsigned int, 32 > PandaNode::get_draw_mask(void) const;

Description: Returns the hide/show bits of this particular node. See set_draw_mask().

getEffect
RenderEffect const *PandaNode::get_effect(TypeHandle type) const;

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

getEffects
RenderEffects const *PandaNode::get_effects(void) const;

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

getInternalBound
BoundingVolume const &PandaNode::get_internal_bound(void) const;

Description: Returns the node's internal bounding volume. This is the bounding volume around the node alone, without including children.

getIntoCollideMask
BitMask< unsigned int, 32 > PandaNode::get_into_collide_mask(void) const;

Description: Returns the "into" collide mask for this node.

getLegalCollideMask
virtual BitMask< unsigned int, 32 > PandaNode::get_legal_collide_mask(void) const;

Description: 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.

getNetCollideMask
BitMask< unsigned int, 32 > PandaNode::get_net_collide_mask(void) const;

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

getNumChildren
int PandaNode::get_num_children(void) const;

Description: Returns the number of child nodes this node has. The order of the child nodes *is* meaningful and is based on the sort number that was passed to add_child(), and also on the order in which the nodes were added.

getNumParents
int PandaNode::get_num_parents(void) const;

Description: 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.

getNumStashed
int PandaNode::get_num_stashed(void) const;

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

getOffClipPlanes
RenderAttrib const *PandaNode::get_off_clip_planes(void) const;

Description: Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned *off* at this level and below.

getParent
PandaNode *PandaNode::get_parent(int n) const;

Description: Returns the nth parent node of this node. See get_num_parents().

getPrevTransform
TransformState const *PandaNode::get_prev_transform(void) const;

Description: Returns the transform that has been set as this node's "previous" position. See set_prev_transform().

getPythonTag
PyObject *PandaNode::get_python_tag(string const &key) const;

Description: Retrieves the Python object that was previously set on this node for the particular key, if any. If no value has been previously set, returns None.

getStashed
PandaNode *PandaNode::get_stashed(int n) const;

Description: Returns the nth stashed node of this node. See get_num_stashed().

getStashedSort
int PandaNode::get_stashed_sort(int n) const;

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

getState
RenderState const *PandaNode::get_state(void) const;

Description: 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.

getTag
string PandaNode::get_tag(string const &key) const;

Description: 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.

getTransform
TransformState const *PandaNode::get_transform(void) const;

Description: Returns the transform that has been set on this particular node. This is not the net transform from the root, but simply the transform on this particular node.

hasAttrib
bool PandaNode::has_attrib(TypeHandle type) const;

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

hasEffect
bool PandaNode::has_effect(TypeHandle type) const;

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

hasPythonTag
bool PandaNode::has_python_tag(string const &key) const;

Description: Returns true if a Python object has been defined on this node for the particular key (even if that object is None), or false if no object has been set.

hasTag
bool PandaNode::has_tag(string const &key) const;

Description: 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.

hasTags
bool PandaNode::has_tags(void) const;

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

isGeomNode
virtual bool PandaNode::is_geom_node(void) const;

Description: A simple downcast check. Returns true if this kind of node happens to inherit from GeomNode, false otherwise.
This is provided as a a faster alternative to calling is_of_type(GeomNode::get_class_type()), since this test is so important to rendering.

isLodNode
virtual bool PandaNode::is_lod_node(void) const;

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

listTags
void PandaNode::list_tags(ostream &out, string const &separator = ("\n")) const;

Description: 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.

ls
void PandaNode::ls(ostream &out, int indent_level) const;

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

output
virtual void PandaNode::output(ostream &out) const;

Description:

removeAllChildren
void PandaNode::remove_all_children(void);

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

removeChild
void PandaNode::remove_child(int n);

Description: Removes the nth child from the node.
Description: 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.

removeStashed
void PandaNode::remove_stashed(int n);

Description: Removes the nth stashed child from the node.

replaceChild
bool PandaNode::replace_child(PandaNode *orig_child, PandaNode *new_child);

Description: 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.

resetPrevTransform
void PandaNode::reset_prev_transform(void);

Description: Resets the "previous" transform on this node to be the same as the current transform. This is not the same as clearing it to identity.

setAttrib
void PandaNode::set_attrib(RenderAttrib const *attrib, int override = (0));

Description: 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.

setBound
void PandaNode::set_bound(BoundedObject::BoundingVolumeType type);

A node has two bounding volumes: the BoundedObject it inherits from is the "external" bound and represents the node and all of its children, while the _internal_bound object is the "internal" bounds and represents only the node itself. We remap the inherited set_bound() and get_bound() functions so that set_bound() to a type sets the type of the external bound, while set_bound() to a specific bounding volume sets the volume of the *internal* bound. At the same time, get_bound() returns the external bound. Although it might seem strange and confusing to do this, this is actually the natural way the user thinks about nodes and bounding volumes.
Description: Sets the type of the external bounding volume that is placed around this node and all of its children.
Description: Resets the internal bounding volume so that it is the indicated volume. The external bounding volume as returned by get_bound() (which includes all of the node's children) will be adjusted to include this internal volume.

setDrawMask
void PandaNode::set_draw_mask(BitMask< unsigned int, 32 > mask);

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

setEffect
void PandaNode::set_effect(RenderEffect const *effect);

Description: Adds the indicated render effect to the scene graph on this node. If there was already an effect of the same type, it is replaced.

setEffects
void PandaNode::set_effects(RenderEffects const *effects);

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

setIntoCollideMask
void PandaNode::set_into_collide_mask(BitMask< unsigned int, 32 > mask);

Description: 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.

setPrevTransform
void PandaNode::set_prev_transform(TransformState const *transform);

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

setPythonTag
void PandaNode::set_python_tag(string const &key, PyObject *value);

Description: Associates an arbitrary Python object with a user-defined key which is stored on the node. This is similar to set_tag(), except it can store any Python object instead of just a string. However, the Python object is not recorded to a bam file.
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.

setState
void PandaNode::set_state(RenderState const *state);

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

setTag
void PandaNode::set_tag(string const &key, string const &value);

Description: 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.

setTransform
void PandaNode::set_transform(TransformState const *transform);

Description: Sets the transform that will be applied to this node and below. This defines a new coordinate space at this point in the scene graph and below.

stashChild
bool PandaNode::stash_child(PandaNode *child_node);

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

stealChildren
void PandaNode::steal_children(PandaNode *other);

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

unstashChild
bool PandaNode::unstash_child(PandaNode *child_node);

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

write
virtual void PandaNode::write(ostream &out, int indent_level) const;

Description:

getClassType
static TypeHandle TypedWritable::get_class_type(void);

Undocumented function.

getBestParentFromSet
int TypedObject::get_best_parent_from_Set(set< int > const &) const;

Description: Returns true if the current object is the indicated type exactly.

getClassType
static TypeHandle TypedObject::get_class_type(void);

Undocumented function.

getType
virtual TypeHandle TypedObject::get_type(void) const = 0;

Derived classes should override this function to return get_class_type().

getTypeIndex
int TypedObject::get_type_index(void) const;

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

isExactType
bool TypedObject::is_exact_type(TypeHandle handle) const;

Description: Returns true if the current object is the indicated type exactly.

isOfType
bool TypedObject::is_of_type(TypeHandle handle) const;

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

clearName
void Namable::clear_name(void);

Description: Resets the Namable's name to empty.

getClassType
static TypeHandle Namable::get_class_type(void);

Undocumented function.

getName
string const &Namable::get_name(void) const;

Description:

hasName
bool Namable::has_name(void) const;

Description: Returns true if the Namable has a nonempty name set, false if the name is empty.

operator =
Namable &Namable::operator =(Namable const &other);

Description:

output
void Namable::output(ostream &out) const;

In the absence of any definition to the contrary, outputting a Namable will write out its name.
Description: Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.

setName
void Namable::set_name(string const &name);

Description:

forceBoundStale
void BoundedObject::force_bound_stale(void);

Description: Marks the current volume as stale and propagates the effect at least one level, even if it had already been marked stale.

getBound
BoundingVolume const &BoundedObject::get_bound(void) const;

Description: Returns the current bounding volume on this node, possibly forcing a recompute. A node's bounding volume encloses only the node itself, irrespective of the nodes above or below it in the graph. This is different from the bounding volumes on the arcs, which enclose all geometry below them.

getClassType
static TypeHandle BoundedObject::get_class_type(void);

Undocumented function.

isBoundStale
bool BoundedObject::is_bound_stale(void) const;

Description: Returns true if the bound is currently marked stale and will be recomputed the next time get_bound() is called.
This function is defined up at the top of this file, because several of the inline functions below reference it.

isFinal
bool BoundedObject::is_final(void) const;

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

markBoundStale
bool BoundedObject::mark_bound_stale(void);

Description: Marks the current bounding volume as stale, so that it will be recomputed later. This may have a cascading effect up to the root of all graphs of which the node is a part. Returns true if the setting was changed, or false if it was already marked stale (or if it is a static bounding volume).

setBound
void BoundedObject::set_bound(BoundedObject::BoundingVolumeType type);

Description: Sets the type of the bounding volume that will be dynamically computed for this particular node. Presently, this should only be BVT_dynamic_sphere.
Description: Explicitly sets a new bounding volume on this node. This will be a static bounding volume that will no longer be recomputed automatically.

setFinal
void BoundedObject::set_final(bool flag);

Description: Sets the "final" flag on this BoundedObject. If this is true, than no bounding volume need be tested below it; a positive intersection with this 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.

getClassType
static TypeHandle ReferenceCount::get_class_type(void);

Undocumented function.

getRefCount
int ReferenceCount::get_ref_count(void) const;

Description: Returns the current reference count.

ref
int ReferenceCount::ref(void) const;

Description: 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.
The return value is the new reference count.

testRefCountIntegrity
bool ReferenceCount::test_ref_count_integrity(void) const;

Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

unref
int ReferenceCount::unref(void) const;

Description: 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; plus, we don't have a virtual destructor anyway.) 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 the new reference count.