bindAnim PointerTo< AnimControl > PartBundle::bind_anim(AnimBundle *anim, int hierarchy_match_flags = (0)); Description: Binds the animation to the bundle, if possible, and returns a new AnimControl that can be used to start and stop the animation. If the anim hierarchy does not match the part hierarchy, returns NULL. If hierarchy_match_flags is 0, only an exact match is accepted; otherwise, it may contain a union of PartGroup::HierarchyMatchFlags values indicating conditions that will be tolerated (but warnings will still be issued). This flavor of bind_anim() does not associate a name with the channel, and the AnimControl is not stored within the PartBundle; it is the user's responsibility to maintain the pointer. The animation will automatically unbind itself when the AnimControl destructs (i.e. its reference count goes to zero). This flavor of bind_anim() automatically stores the bound AnimControl in the PartBundle with the indicated name, so that it may later be referenced by name. This means that the animation will not be unbound until another animation with the same name is bound, or it is explicitly unbound with unbind_anim(). The return value is true if the animation was successfully bound, false if there was some error. |
clearControlEffects void PartBundle::clear_control_effects(void); Description: Sets the control effect of all AnimControls to zero (but does not "stop" the AnimControls). The character will no longer be affected by any animation, and will return to its original Jesus pose. The AnimControls which are no longer associated will not be using any CPU cycles, but they may still be in the "playing" state; if they are later reassociated with the PartBundle they will resume at their current frame as if they'd been running all along. |
getBlendType PartBundle::BlendType PartBundle::get_blend_type(void) const; Filename: partBundle.I Created by: drose (22Feb99) 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: Returns the way the character responds to multiple animations being bound simultaneously. |
getClassType static TypeHandle PartBundle::get_class_type(void); Undocumented function. |
getControlEffect float PartBundle::get_control_effect(AnimControl *control); Description: Returns the amount by which the character is affected by the indicated AnimControl and its associated animation. See set_control_effect(). |
getNode PartBundleNode *PartBundle::get_node(void) const; Description: Returns the PartBundleNode associated with this PartBundle. |
output virtual void PartBundle::output(ostream &out) const; Description: Writes a one-line description of the bundle. |
setBlendType void PartBundle::set_blend_type(PartBundle::BlendType bt); Description: Defines the way the character responds to multiple set_control_effect()). By default, the blend_type is BT_single, which disallows multiple animations. In BT_single mode, it is not necessary to explicitly set the control_effect when starting an animation; starting the animation will implicitly remove the control_effect from the previous animation and set it on the current one. However, if the blend_type is set to any other value, the control_effect must be explicitly set via set_control_effect() whenever an animation is to affect the character. See partBundle.h for a description of the meaning of each of the BlendType values. |
setControlEffect void PartBundle::set_control_effect(AnimControl *control, float effect); Description: Sets the amount by which the character is affected by the indicated AnimControl (and its associated animation). Normally, this will only be zero or one. Zero indicates the animation does not affect the character, and one means it does. If the blend_type is not BT_single (see set_blend_type()), it is possible to have multiple AnimControls in effect simultaneously. In this case, the effect is a weight that indicates the relative importance of each AnimControl to the final animation. |
write virtual void PartBundle::write(ostream &out, int indent_level) const; Description: Writes a brief description of the bundle and all of its descendants. |
findChild PartGroup *PartGroup::find_child(string const &name) const; Description: Returns the first descendant found with the indicated name, or NULL if no such descendant exists. |
getChild PartGroup *PartGroup::get_child(int n) const; Description: Returns the nth child of the group. |
getClassType static TypeHandle PartGroup::get_class_type(void); Undocumented function. |
getNumChildren int PartGroup::get_num_children(void) const; Description: Returns the number of child nodes of the group. |
write virtual void PartGroup::write(ostream &out, int indent_level) const; Description: Writes a brief description of the group and all of its descendants. |
writeWithValue virtual void PartGroup::write_with_value(ostream &out, int indent_level) const; Description: Writes a brief description of the group, showing its current value, and that of all of its descendants. |
getClassType static TypeHandle TypedWritableReferenceCount::get_class_type(void); Undocumented function. |
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. |
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. |
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: |
clearAnims void AnimControlCollection::clear_anims(void); Description: Disassociates all anims from this collection. |
findAnim AnimControl *AnimControlCollection::find_anim(string const &name) const; Description: Returns the AnimControl associated with the given name, or NULL if no such control has been associated. |
getAnim AnimControl *AnimControlCollection::get_anim(int n) const; Description: Returns the nth AnimControl associated with this collection. |
getAnimName string AnimControlCollection::get_anim_name(int n) const; Description: Returns the name of the nth AnimControl associated with this collection. |
getFrame int AnimControlCollection::get_frame(string const &anim_name) const; Description: Returns the current frame in the named animation, or 0 if the animation is not found. Description: Returns the current frame in the last-started animation. |
getNumAnims int AnimControlCollection::get_num_anims(void) const; Description: Returns the number of AnimControls associated with this collection. |
getNumFrames int AnimControlCollection::get_num_frames(string const &anim_name) const; Description: Returns the total number of frames in the named animation, or 0 if the animation is not found. Description: Returns the total number of frames in the last-started animation. |
isPlaying bool AnimControlCollection::is_playing(string const &anim_name) const; Description: Returns true if the named animation is currently playing, false otherwise. Description: Returns true if the last-started animation is currently playing, false otherwise. |
loop bool AnimControlCollection::loop(string const &anim_name, bool restart); Description: Starts the named animation looping. |
loopAll void AnimControlCollection::loop_all(bool restart); Description: Starts all animations looping. |
output void AnimControlCollection::output(ostream &out) const; Description: |
play bool AnimControlCollection::play(string const &anim_name); The following functions are convenience functions that vector directly into the AnimControl's functionality by anim name. Filename: animControlCollection.I Created by: drose (22Feb00) 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: Starts the named animation playing. |
playAll void AnimControlCollection::play_all(void); These functions operate on all anims at once. Description: Starts all animations playing. |
pose bool AnimControlCollection::pose(string const &anim_name, int frame); Description: Sets to a particular frame in the named animation. |
poseAll void AnimControlCollection::pose_all(int frame); Description: Sets all animations to the indicated frame. |
stop bool AnimControlCollection::stop(string const &anim_name); Description: Stops the named animation. |
stopAll bool AnimControlCollection::stop_all(void); Description: Stops all currently playing animations. Returns true if any animations were stopped, false if none were playing. |
storeAnim void AnimControlCollection::store_anim(AnimControl *control, string const &name); Description: Associates the given AnimControl with this collection under the given name. The AnimControl will remain associated until a new AnimControl is associated with the same name later, or until unbind_anim() is called with this name. |
unbindAnim bool AnimControlCollection::unbind_anim(string const &name); Description: Removes the AnimControl associated with the given name, if any. Returns true if an AnimControl was removed, false if there was no AnimControl with the indicated name. |
whichAnimPlaying string AnimControlCollection::which_anim_playing(void) const; Description: Returns the name of the bound AnimControl currently playing, if any. If more than one AnimControl is currently playing, returns all of the names separated by spaces. |
write void AnimControlCollection::write(ostream &out) const; Description: |