DriveInterface

Inheritance:

Methods of DriveInterface:

Methods of MouseInterfaceNode:

Methods of DataNode:

Methods of PandaNode:

Methods of TypedWritable:

Methods of TypedObject:

Methods of Namable:

Methods of ReferenceCount:

forceDgraph
void DriveInterface::force_dgraph(void);

Description: This is a special kludge for DriveInterface to allow us to avoid the one-frame latency after a collision. It forces an immediate partial data flow for all data graph nodes below this node, causing all data nodes that depend on this matrix to be updated immediately.

getClassType
static TypeHandle DriveInterface::get_class_type(void);

Undocumented function.

getForceMouse
bool DriveInterface::get_force_mouse(void) const;

Description: Returns the current setting of the force_mouse flag. See set_force_mouse().

getForwardSpeed
float DriveInterface::get_forward_speed(void) const;

Description: Returns the speed of full forward motion, when the mouse is at the very top of the window. This is in units (e.g. feet) per second.

getH
float DriveInterface::get_h(void) const;

Undocumented function.

getHorizontalDeadZone
float DriveInterface::get_horizontal_dead_zone(void) const;

Description: Returns the size of the vertical bar in the center of the screen that represents the "dead zone" of horizontal motion: the region in which the mouse does not report horizontal motion. This is in a fraction of the window width, so 0.5 will set a dead zone as large as half the screen.

getHorizontalRampDownTime
float DriveInterface::get_horizontal_ramp_down_time(void) const;

Description: Returns the amount of time, in seconds, it takes between the time a left or right arrow key is released and the time it registers no motion.

getHorizontalRampUpTime
float DriveInterface::get_horizontal_ramp_up_time(void) const;

Description: Returns the amount of time, in seconds, it takes between the time a left or right arrow key is pressed and the time it registers full rotation.

getHpr
LVecBase3f const &DriveInterface::get_hpr(void) const;

**** Rotation ****
Description: Returns the driver's orientation.

getIgnoreMouse
bool DriveInterface::get_ignore_mouse(void) const;

Description: Returns the current setting of the ignore_mouse flag. See set_ignore_mouse().

getMat
LMatrix4f const &DriveInterface::get_mat(void);

Description: Returns the current transform.

getP
float DriveInterface::get_p(void) const;

Undocumented function.

getPos
LPoint3f const &DriveInterface::get_pos(void) const;

**** Translation ****
Description: Returns the driver's position.

getR
float DriveInterface::get_r(void) const;

Undocumented function.

getReverseSpeed
float DriveInterface::get_reverse_speed(void) const;

Description: Returns the speed of full reverse motion, when the mouse is at the very bottom of the window. This is in units (e.g. feet) per second.

getRotateSpeed
float DriveInterface::get_rotate_speed(void) const;

Description: Returns the maximum rate at which the user can rotate left or right, when the mouse is at the very edge of the window. This is in degrees per second.

getRotSpeed
float DriveInterface::get_rot_speed(void) const;

Description: Returns the rot_speed of the previous update in units/sec

getSpeed
float DriveInterface::get_speed(void) const;

Description: Returns the speed of the previous update in units/sec

getStopThisFrame
bool DriveInterface::get_stop_this_frame(void) const;

Description: Returns the current setting of the stop_this_frame flag. See set_stop_this_frame().

getVerticalDeadZone
float DriveInterface::get_vertical_dead_zone(void) const;

Description: Returns the size of the horizontal bar in the center of the screen that represents the "dead zone" of vertical motion: the region in which the mouse does not report vertical motion. This is in a fraction of the window height, so 0.5 will set a dead zone as large as half the screen.

getVerticalRampDownTime
float DriveInterface::get_vertical_ramp_down_time(void) const;

Description: Returns the amount of time, in seconds, it takes between the time an up or down arrow key is released and the time it registers no motion.

getVerticalRampUpTime
float DriveInterface::get_vertical_ramp_up_time(void) const;

Description: Returns the amount of time, in seconds, it takes between the time an up or down arrow key is pressed and the time it registers full forward or backward motion.

getX
float DriveInterface::get_x(void) const;

Undocumented function.

getY
float DriveInterface::get_y(void) const;

Undocumented function.

getZ
float DriveInterface::get_z(void) const;

Undocumented function.

reset
void DriveInterface::reset(void);

Description: Reinitializes the driver to the origin and resets any knowledge about buttons being held down.

setForceMouse
void DriveInterface::set_force_mouse(bool force_mouse);

Description: Changes the state of the force_mouse flag. If this flag is true, the mouse button need not be held down in order to drive the avatar around.

setForceRoll
void DriveInterface::set_force_roll(float force_roll);

Description: This function is no longer used and does nothing. It will be removed soon.

setForwardSpeed
void DriveInterface::set_forward_speed(float speed);

Filename: driveInterface.I Created by: drose (12Mar02)
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 speed of full forward motion, when the mouse is at the very top of the window. This is in units (e.g. feet) per second.

setH
void DriveInterface::set_h(float h);

Undocumented function.

setHorizontalDeadZone
void DriveInterface::set_horizontal_dead_zone(float zone);

Description: Sets the size of the vertical bar in the center of the screen that represents the "dead zone" of horizontal motion: the region in which the mouse does not report horizontal motion. This is in a fraction of the window width, so 0.5 will set a dead zone as large as half the screen.

setHorizontalRampDownTime
void DriveInterface::set_horizontal_ramp_down_time(float ramp_down_time);

Description: Sets the amount of time, in seconds, it takes between the time a left or right arrow key is released and the time it registers no motion.

setHorizontalRampUpTime
void DriveInterface::set_horizontal_ramp_up_time(float ramp_up_time);

Description: Sets the amount of time, in seconds, it takes between the time a left or right arrow key is pressed and the time it registers full rotation.

setHpr
void DriveInterface::set_hpr(LVecBase3f const &hpr);

Description: Directly sets the driver's orientation.

setIgnoreMouse
void DriveInterface::set_ignore_mouse(bool ignore_mouse);

Description: Changes the state of the ignore_mouse flag. If this flag is true, the DriveInterface will ignore mouse down button events (but still recognize mouse up button events); the user will not be able to start the DriveInterface going again if it is stopped, but if the user is currently holding down a mouse button it will not stop immediately until the user eventually releases the button.

setMat
void DriveInterface::set_mat(LMatrix4f const &mat);

Description: Stores the indicated transform in the DriveInterface.

setP
void DriveInterface::set_p(float p);

Undocumented function.

setPos
void DriveInterface::set_pos(LVecBase3f const &vec);

Description: Directly sets the driver's position.

setR
void DriveInterface::set_r(float r);

Undocumented function.

setReverseSpeed
void DriveInterface::set_reverse_speed(float speed);

Description: Sets the speed of full reverse motion, when the mouse is at the very bottom of the window. This is in units (e.g. feet) per second.

setRotateSpeed
void DriveInterface::set_rotate_speed(float speed);

Description: Sets the maximum rate at which the user can rotate left or right, when the mouse is at the very edge of the window. This is in degrees per second.

setStopThisFrame
void DriveInterface::set_stop_this_frame(bool stop_this_frame);

Description: If stop_this_frame is true, the next time the frame is computed no motion will be allowed, and then the flag is reset to false. This can be used to prevent too much movement when we know a long time has artificially elapsed, for instance when we take a screenshot, without munging the clock for everything else.

setVerticalDeadZone
void DriveInterface::set_vertical_dead_zone(float zone);

Description: Sets the size of the horizontal bar in the center of the screen that represents the "dead zone" of vertical motion: the region in which the mouse does not report vertical motion. This is in a fraction of the window height, so 0.5 will set a dead zone as large as half the screen.

setVerticalRampDownTime
void DriveInterface::set_vertical_ramp_down_time(float ramp_down_time);

Description: Sets the amount of time, in seconds, it takes between the time an up or down arrow key is released and the time it registers no motion.

setVerticalRampUpTime
void DriveInterface::set_vertical_ramp_up_time(float ramp_up_time);

Description: Sets the amount of time, in seconds, it takes between the time an up or down arrow key is pressed and the time it registers full forward or backward motion.

setX
void DriveInterface::set_x(float x);

Undocumented function.

setY
void DriveInterface::set_y(float y);

Undocumented function.

setZ
void DriveInterface::set_z(float z);

Undocumented function.

clearAllButtons
void MouseInterfaceNode::clear_all_buttons(void);

Description: Removes all requirements on buttons set by an earlier call to require_button().

clearButton
void MouseInterfaceNode::clear_button(ButtonHandle const &button);

Description: Removes any requirement on the indicated button set by an earlier call to require_button().

getClassType
static TypeHandle MouseInterfaceNode::get_class_type(void);

Undocumented function.

requireButton
void MouseInterfaceNode::require_button(ButtonHandle const &button, bool is_down);

Description: Indicates that the indicated button must be in the required state (either up or down) in order for this particular MouseInterfaceNode to do anything. For instance, this may be called to make a Trackball object respect mouse input only when the control key is held down.

getClassType
static TypeHandle DataNode::get_class_type(void);

Undocumented function.

writeConnections
void DataNode::write_connections(ostream &out) const;

Description: Writes to the indicated ostream a list of all the connections currently showing between this DataNode and its parent(s).

writeInputs
void DataNode::write_inputs(ostream &out) const;

Description: Writes to the indicated ostream a list of all the inputs this DataNode might expect to receive.

writeOutputs
void DataNode::write_outputs(ostream &out) const;

Description: Writes to the indicated ostream a list of all the outputs this DataNode might generate.

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.
This can only be called from the top pipeline stage (i.e. from App).

adjustDrawMask
void PandaNode::adjust_draw_mask(BitMask< unsigned int, 32 > show_mask, BitMask< unsigned int, 32 > hide_mask, BitMask< unsigned int, 32 > clear_mask);

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

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.

clearBounds
void PandaNode::clear_bounds(void);

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

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.

getBounds
ConstPointerTo< BoundingVolume > PandaNode::get_bounds(void) const;

Description: Returns the external bounding volume of this node: a bounding volume that contains the user bounding volume, the internal bounding volume, and all of the children's bounding volumes.

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.

getDrawControlMask
BitMask< unsigned int, 32 > PandaNode::get_draw_control_mask(void) const;

Description: Returns the set of bits in draw_show_mask that are considered meaningful. See adjust_draw_mask().

getDrawShowMask
BitMask< unsigned int, 32 > PandaNode::get_draw_show_mask(void) const;

Description: Returns the hide/show bits of this particular node. See adjust_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.

getInternalBounds
ConstPointerTo< BoundingVolume > PandaNode::get_internal_bounds(void) const;

Description: Returns the node's internal bounding volume. This is the bounding volume around the node alone, without including children. If the user has called set_bounds(), it will be the specified bounding volume.
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.

getNetDrawControlMask
BitMask< unsigned int, 32 > PandaNode::get_net_draw_control_mask(void) const;

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

getNetDrawShowMask
BitMask< unsigned int, 32 > PandaNode::get_net_draw_show_mask(void) const;

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

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
ConstPointerTo< RenderAttrib > 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.

getOverallBit
static BitMask< unsigned int, 32 > PandaNode::get_overall_bit(void);

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

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().
Description: Returns an object that can be used to walk through the list of stashed 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 keeps the PipelineCycler open the whole time.
However, this object does not protect you from self-modifying loops (e.g. adding or removing stashed during traversal). Furthermore, if Panda is compiled with pipelining enabled, this method is compiled to behave exactly as get_stashed_copy(): it returns a copy. This is intended to reduce the risk of deadlocks.

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.

isFinal
bool PandaNode::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().

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

isOverallHidden
bool PandaNode::is_overall_hidden(void) const;

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

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.

markBoundsStale
void PandaNode::mark_bounds_stale(void) const;

Description: Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CDataBounds, 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.

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.
This can only be called from the top pipeline stage (i.e. from App).

removeChild
void PandaNode::remove_child(int child_index);

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 child_index);

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(BoundingVolume const *volume);

A node has three bounding volumes: an "external" bounding volume that represents the node and all of its children, an "internal" bounding volume which represents only the node itself (and is usually empty, unless a specific node type sets it otherwise), and a "user" bounding volume which is specified by the user. We define set_bounds() and get_bounds() functions so that set_bounds() sets the user bounding volume, while get_bounds() returns the external bounding volume. 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: Deprecated. Use set_bounds() instead.

setBounds
void PandaNode::set_bounds(BoundingVolume const *volume);

A node has three bounding volumes: an "external" bounding volume that represents the node and all of its children, an "internal" bounding volume which represents only the node itself (and is usually empty, unless a specific node type sets it otherwise), and a "user" bounding volume which is specified by the user. We define set_bounds() and get_bounds() functions so that set_bounds() sets the user bounding volume, while get_bounds() returns the external bounding volume. 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: 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.

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

setFinal
void PandaNode::set_final(bool flag);

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

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.

setOverallHidden
void PandaNode::set_overall_hidden(bool overall_hidden);

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

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).
This can only be called from the top pipeline stage (i.e. from App).

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).
This can only be called from the top pipeline stage (i.e. from App).

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:

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

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
bool 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 true if the new reference count is nonzero, false if it is zero.