Panda3D
Public Member Functions | Static Public Member Functions | List of all members
DriveInterface Class Reference

This is a TFormer, similar to Trackball, that moves around a transform matrix in response to mouse input. The basic motion is on a horizontal plane, as if driving a vehicle. More...

Inheritance diagram for DriveInterface:
MouseInterfaceNode DataNode PandaNode TypedWritableReferenceCount Namable LinkedListNode TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase

Public Member Functions

 __init__ (str name)
 
 forceDgraph ()
 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. More...
 
bool getForceMouse ()
 Returns the current setting of the force_mouse flag. See set_force_mouse(). More...
 
float getForwardSpeed ()
 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. More...
 
float getH ()
 
float getHorizontalDeadZone ()
 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. More...
 
float getHorizontalRampDownTime ()
 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. More...
 
float getHorizontalRampUpTime ()
 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. More...
 
const LVecBase3 getHpr ()
 Returns the driver's orientation. More...
 
bool getIgnoreMouse ()
 Returns the current setting of the ignore_mouse flag. See set_ignore_mouse(). More...
 
const LMatrix4 getMat ()
 Returns the current transform. More...
 
float getP ()
 
const LPoint3 getPos ()
 Returns the driver's position. More...
 
float getR ()
 
float getReverseSpeed ()
 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. More...
 
float getRotateSpeed ()
 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. More...
 
float getRotSpeed ()
 Returns the rot_speed of the previous update in units/sec. More...
 
float getSpeed ()
 Returns the speed of the previous update in units/sec. More...
 
bool getStopThisFrame ()
 Returns the current setting of the stop_this_frame flag. See set_stop_this_frame(). More...
 
float getVerticalDeadZone ()
 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. More...
 
float getVerticalRampDownTime ()
 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. More...
 
float getVerticalRampUpTime ()
 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. More...
 
float getX ()
 
float getY ()
 
float getZ ()
 
 reset ()
 Reinitializes the driver to the origin and resets any knowledge about buttons being held down. More...
 
 setForceMouse (bool force_mouse)
 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. More...
 
 setForceRoll (float force_roll)
 This function is no longer used and does nothing. It will be removed soon. More...
 
 setForwardSpeed (float speed)
 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. More...
 
 setH (float h)
 
 setHorizontalDeadZone (float zone)
 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. More...
 
 setHorizontalRampDownTime (float ramp_down_time)
 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. More...
 
 setHorizontalRampUpTime (float ramp_up_time)
 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. More...
 
 setHpr (const LVecBase3 hpr)
 Directly sets the driver's orientation. More...
 
 setHpr (float h, float p, float r)
 
 setIgnoreMouse (bool ignore_mouse)
 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. More...
 
 setMat (const LMatrix4 mat)
 Stores the indicated transform in the DriveInterface. More...
 
 setP (float p)
 
 setPos (const LVecBase3 vec)
 Directly sets the driver's position. More...
 
 setPos (float x, float y, float z)
 
 setR (float r)
 
 setReverseSpeed (float speed)
 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. More...
 
 setRotateSpeed (float speed)
 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. More...
 
 setStopThisFrame (bool stop_this_frame)
 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. More...
 
 setVerticalDeadZone (float zone)
 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. More...
 
 setVerticalRampDownTime (float ramp_down_time)
 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. More...
 
 setVerticalRampUpTime (float ramp_up_time)
 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. More...
 
 setX (float x)
 
 setY (float y)
 
 setZ (float z)
 
- Public Member Functions inherited from MouseInterfaceNode
 clearAllButtons ()
 Removes all requirements on buttons set by an earlier call to require_button(). More...
 
 clearButton (const ButtonHandle button)
 Removes any requirement on the indicated button set by an earlier call to require_button(). More...
 
 requireButton (const ButtonHandle button, bool is_down)
 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. More...
 
- Public Member Functions inherited from DataNode
 __init__ (str name)
 
 writeConnections (Ostream out)
 Writes to the indicated ostream a list of all the connections currently showing between this DataNode and its parent(s). More...
 
 writeInputs (Ostream out)
 Writes to the indicated ostream a list of all the inputs this DataNode might expect to receive. More...
 
 writeOutputs (Ostream out)
 Writes to the indicated ostream a list of all the outputs this DataNode might generate. More...
 
- Public Member Functions inherited from PandaNode
PandaNode __copy__ ()
 
object __deepcopy__ (object memo)
 
 __init__ (str name)
 
 addChild (PandaNode child_node, int sort, Thread current_thread)
 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. More...
 
 addStashed (PandaNode child_node, int sort, Thread current_thread)
 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. More...
 
 adjustDrawMask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
Light asLight ()
 Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More...
 
 clearAttrib (TypeHandle type)
 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. More...
 
 clearAttrib (int slot)
 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. More...
 
 clearBounds ()
 Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More...
 
 clearEffect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
 clearEffects (Thread current_thread)
 Resets this node to have no render effects. More...
 
 clearPythonTag (str key)
 
 clearState (Thread current_thread)
 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. More...
 
 clearTag (str key, Thread current_thread)
 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. More...
 
 clearTransform (Thread current_thread)
 Resets the transform on this node to the identity transform. More...
 
 clearUnexpectedChange (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. See set_unexpected_change(). More...
 
PandaNode combineWith (PandaNode other)
 Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined. More...
 
int compareTags (const PandaNode other)
 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. More...
 
 copyAllProperties (PandaNode other)
 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()). More...
 
 copyChildren (PandaNode other, Thread current_thread)
 Makes another instance of all the children of the other node, copying them to this node. More...
 
PandaNode copySubgraph (Thread current_thread)
 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. More...
 
 copyTags (PandaNode other)
 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. More...
 
int countNumDescendants ()
 Returns the number of nodes at and below this level. More...
 
int findChild (PandaNode node, Thread current_thread)
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int findParent (PandaNode node, Thread current_thread)
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int findStashed (PandaNode node, Thread current_thread)
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
const RenderAttrib getAttrib (TypeHandle type)
 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. More...
 
const RenderAttrib getAttrib (int slot)
 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. More...
 
const BoundingVolume getBounds (Thread current_thread)
 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. More...
 
const BoundingVolume getBounds (UpdateSeq seq, Thread current_thread)
 This flavor of get_bounds() return the external bounding volume, and also fills in seq with the bounding volume's current sequence number. When this sequence number changes, it indicates that the bounding volume might have changed, e.g. because some nested child's bounding volume has changed. More...
 
BoundingVolume::BoundsType getBoundsType ()
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode getChild (int n, Thread current_thread)
 Returns the nth child node of this node. See get_num_children(). Also see get_children(), if your intention is to iterate through the complete list of children; get_children() is preferable in this case. More...
 
list getChildren ()
 
int getChildSort (int n, Thread current_thread)
 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(). More...
 
DrawMask getDrawControlMask ()
 Returns the set of bits in draw_show_mask that are considered meaningful. See adjust_draw_mask(). More...
 
DrawMask getDrawShowMask ()
 Returns the hide/show bits of this particular node. See adjust_draw_mask(). More...
 
const RenderEffect getEffect (TypeHandle type)
 Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderEffects getEffects (Thread current_thread)
 Returns the complete RenderEffects that will be applied to this node. More...
 
int getFancyBits (Thread current_thread)
 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. More...
 
const BoundingVolume getInternalBounds (Thread current_thread)
 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. More...
 
int getInternalVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask getIntoCollideMask ()
 Returns the "into" collide mask for this node. More...
 
CollideMask getLegalCollideMask ()
 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. More...
 
int getNestedVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
CollideMask getNetCollideMask (Thread current_thread)
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask getNetDrawControlMask ()
 Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More...
 
DrawMask getNetDrawShowMask ()
 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. More...
 
int getNumChildren (Thread current_thread)
 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. More...
 
int getNumParents (Thread current_thread)
 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. More...
 
int getNumStashed (Thread current_thread)
 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(). More...
 
const RenderAttrib getOffClipPlanes (Thread current_thread)
 Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned off at this level and below. More...
 
PandaNode getParent (int n, Thread current_thread)
 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. More...
 
list getParents ()
 
const TransformState getPrevTransform (Thread current_thread)
 Returns the transform that has been set as this node's "previous" position. See set_prev_transform(). More...
 
object getPythonTag (str key)
 
object getPythonTagKeys ()
 
 getPythonTagKeys (VectorString keys)
 
PandaNode getStashed (int n, Thread current_thread)
 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. More...
 
list getStashed ()
 
int getStashedSort (int n, Thread current_thread)
 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(). More...
 
const RenderState getState (Thread current_thread)
 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. More...
 
str getTag (str key, Thread current_thread)
 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. More...
 
object getTagKeys ()
 
 getTagKeys (VectorString keys)
 Fills the given vector up with the list of tags on this PandaNode. More...
 
const TransformState getTransform (Thread current_thread)
 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. More...
 
unsigned int getUnexpectedChange (unsigned int flags)
 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(). More...
 
bool hasAttrib (TypeHandle type)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasAttrib (int slot)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasDirtyPrevTransform ()
 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(). More...
 
bool hasEffect (TypeHandle type)
 Returns true if there is a render effect of the indicated type defined on this node, or false if there is not. More...
 
bool hasPythonTag (str key)
 
bool hasTag (str key, Thread current_thread)
 Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set. More...
 
bool hasTags ()
 Returns true if the node has any tags (or any Python tags) at all, false if it has none. More...
 
bool isAmbientLight ()
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool isBoundsStale ()
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
bool isCollisionNode ()
 A simple downcast check. Returns true if this kind of node happens to inherit from CollisionNode, false otherwise. More...
 
bool isFinal (Thread current_thread)
 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(). More...
 
bool isGeomNode ()
 A simple downcast check. Returns true if this kind of node happens to inherit from GeomNode, false otherwise. More...
 
bool isLodNode ()
 A simple downcast check. Returns true if this kind of node happens to inherit from LODNode, false otherwise. More...
 
bool isOverallHidden ()
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
bool isSceneRoot ()
 Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More...
 
bool isUnderSceneRoot ()
 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. More...
 
 listTags (Ostream out, str separator)
 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. More...
 
 ls (Ostream out, int indent_level)
 Lists all the nodes at and below the current path hierarchically. More...
 
PandaNode makeCopy ()
 Returns a newly-allocated PandaNode that is a shallow copy of this one. It will be a different pointer, but its internal data may or may not be shared with that of the original PandaNode. No children will be copied. More...
 
 markBoundsStale (Thread current_thread)
 Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CData, like net_collide_mask), may have changed for this node, and that it must be recomputed. More...
 
 markInternalBoundsStale (Thread current_thread)
 Should be called by a derived class to mark the internal bounding volume stale, so that compute_internal_bounds() will be called when the bounding volume is next requested. More...
 
 output (Ostream out)
 
 prepareScene (GraphicsStateGuardianBase gsg, const RenderState node_state)
 Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG. 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. More...
 
 removeAllChildren (Thread current_thread)
 Removes all the children from the node at once, including stashed children. More...
 
bool removeChild (PandaNode child_node, Thread current_thread)
 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. More...
 
 removeChild (int child_index, Thread current_thread)
 Removes the nth child from the node. More...
 
 removeStashed (int child_index, Thread current_thread)
 Removes the nth stashed child from the node. More...
 
bool replaceChild (PandaNode orig_child, PandaNode new_child, Thread current_thread)
 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. More...
 
 replaceNode (PandaNode other)
 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. More...
 
 resetPrevTransform (Thread current_thread)
 Resets the transform that represents this node's "previous" position to the same as the current transform. This is not the same thing as clearing it to identity. More...
 
 setAttrib (const RenderAttrib attrib, int override)
 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. More...
 
 setBound (const BoundingVolume volume)
 Deprecated. Use set_bounds() instead. More...
 
 setBounds (const BoundingVolume volume)
 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). More...
 
 setBoundsType (BoundingVolume::BoundsType bounds_type)
 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". More...
 
 setEffect (const RenderEffect effect)
 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. More...
 
 setEffects (const RenderEffects effects, Thread current_thread)
 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(). More...
 
 setFinal (bool flag)
 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. More...
 
 setIntoCollideMask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
 setOverallHidden (bool overall_hidden)
 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. More...
 
 setPrevTransform (const TransformState transform, Thread current_thread)
 Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More...
 
 setPythonTag (str key, object value)
 
 setState (const RenderState state, Thread current_thread)
 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(). More...
 
 setTag (str key, str value, Thread current_thread)
 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. More...
 
 setTransform (const TransformState transform, Thread current_thread)
 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. More...
 
 setUnexpectedChange (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. 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. More...
 
bool stashChild (PandaNode child_node, Thread current_thread)
 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(). More...
 
 stashChild (int child_index, Thread current_thread)
 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(). More...
 
 stealChildren (PandaNode other, Thread current_thread)
 Moves all the children from the other node onto this node. More...
 
bool unstashChild (PandaNode child_node, Thread current_thread)
 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. More...
 
 unstashChild (int stashed_index, Thread current_thread)
 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. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
str encodeToBamStream ()
 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. More...
 
bool encodeToBamStream (String data, BamWriter writer)
 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. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 Derived classes should override this function to return get_class_type(). More...
 
int getTypeIndex ()
 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(). More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 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. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
 
bool unref ()
 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(). More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable copy)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
Namable operator= (const Namable other)
 
 output (Ostream out)
 Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this. More...
 
 setName (str name)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from MouseInterfaceNode
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from DataNode
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from PandaNode
static PandaNode decodeFromBamStream (str data, BamReader reader)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. More...
 
static DrawMask getAllCameraMask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle getClassType ()
 
static DrawMask getOverallBit ()
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
static resetAllPrevTransform (Thread current_thread)
 Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (str data, BamReader reader)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Types inherited from PandaNode
enum  FancyBits {
  FB_transform = 1, FB_state = 2, FB_effects = 4, FB_tag = 16,
  FB_draw_mask = 32, FB_cull_callback = 64
}
 
enum  UnexpectedChange {
  UC_parents = 1, UC_children = 2, UC_transform = 4, UC_state = 8,
  UC_draw_mask = 16
}
 

Detailed Description

This is a TFormer, similar to Trackball, that moves around a transform matrix in response to mouse input. The basic motion is on a horizontal plane, as if driving a vehicle.

Member Function Documentation

◆ __init__()

__init__ ( str  name)

◆ forceDgraph()

forceDgraph ( )

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 getClassType ( )
static

◆ getForceMouse()

bool getForceMouse ( )

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

◆ getForwardSpeed()

float getForwardSpeed ( )

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

◆ getHorizontalDeadZone()

float getHorizontalDeadZone ( )

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

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

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

const LVecBase3 getHpr ( )

Returns the driver's orientation.

◆ getIgnoreMouse()

bool getIgnoreMouse ( )

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

◆ getMat()

const LMatrix4 getMat ( )

Returns the current transform.

◆ getP()

float getP ( )

◆ getPos()

const LPoint3 getPos ( )

Returns the driver's position.

◆ getR()

float getR ( )

◆ getReverseSpeed()

float getReverseSpeed ( )

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

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

Returns the rot_speed of the previous update in units/sec.

◆ getSpeed()

float getSpeed ( )

Returns the speed of the previous update in units/sec.

◆ getStopThisFrame()

bool getStopThisFrame ( )

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

◆ getVerticalDeadZone()

float getVerticalDeadZone ( )

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

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

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

◆ getY()

float getY ( )

◆ getZ()

float getZ ( )

◆ reset()

reset ( )

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

◆ setForceMouse()

setForceMouse ( bool  force_mouse)

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

setForceRoll ( float  force_roll)

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

◆ setForwardSpeed()

setForwardSpeed ( float  speed)

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

setH ( float  h)

◆ setHorizontalDeadZone()

setHorizontalDeadZone ( float  zone)

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

setHorizontalRampDownTime ( float  ramp_down_time)

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

setHorizontalRampUpTime ( float  ramp_up_time)

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() [1/2]

setHpr ( const LVecBase3  hpr)

Directly sets the driver's orientation.

◆ setHpr() [2/2]

setHpr ( float  h,
float  p,
float  r 
)

◆ setIgnoreMouse()

setIgnoreMouse ( bool  ignore_mouse)

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

setMat ( const LMatrix4  mat)

Stores the indicated transform in the DriveInterface.

◆ setP()

setP ( float  p)

◆ setPos() [1/2]

setPos ( const LVecBase3  vec)

Directly sets the driver's position.

◆ setPos() [2/2]

setPos ( float  x,
float  y,
float  z 
)

◆ setR()

setR ( float  r)

◆ setReverseSpeed()

setReverseSpeed ( float  speed)

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

setRotateSpeed ( float  speed)

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

setStopThisFrame ( bool  stop_this_frame)

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

setVerticalDeadZone ( float  zone)

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

setVerticalRampDownTime ( float  ramp_down_time)

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

setVerticalRampUpTime ( float  ramp_up_time)

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

setX ( float  x)

◆ setY()

setY ( float  y)

◆ setZ()

setZ ( float  z)