Panda3D
|
A template definition in the X file. More...
#include "xFileTemplate.h"
Public Types | |
typedef pmap< const XFileDataDef *, XFileDataObject * > | PrevData |
Public Member Functions | |
XFileTemplate (XFile *x_file, const string &name, const WindowsGuid &guid) | |
void | add_child (XFileNode *node) |
Adds the indicated node as a child of this node. | |
XFileDataNode * | add_Frame (const string &name) |
Creates a new Frame instance, as a child of this node. | |
XFileDataNode * | add_FrameTransformMatrix (const LMatrix4d &mat) |
Creates a new FrameTransformMatrix instance, as a child of this node. | |
XFileDataNode * | add_Material (const string &name, const Colorf &face_color, double power, const RGBColorf &specular_color, const RGBColorf &emissive_color) |
Creates a new Material instance, as a child of this node. | |
XFileDataNode * | add_Mesh (const string &name) |
Creates a new Mesh instance, as a child of this node. | |
XFileDataNode * | add_MeshMaterialList (const string &name) |
Creates a new MeshMaterialList instance, as a child of this node. | |
XFileDataNode * | add_MeshNormals (const string &name) |
Creates a new MeshNormals instance, as a child of this node. | |
XFileDataNode * | add_MeshTextureCoords (const string &name) |
Creates a new MeshTextureCoords instance, as a child of this node. | |
XFileDataNode * | add_MeshVertexColors (const string &name) |
Creates a new MeshVertexColors instance, as a child of this node. | |
void | add_option (XFileTemplate *option) |
Adds a new type to the list of allowable types of child nodes for an instance of this template. | |
XFileDataNode * | add_TextureFilename (const string &name, const Filename &filename) |
Creates a new TextureFilename instance, as a child of this node. | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
const TypedObject * | as_typed_object () const |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
virtual void | clear () |
Removes all children from the node, and otherwise resets it to its initial state. | |
void | clear_name () |
Resets the Namable's name to empty. | |
virtual bool | fill_zero_data (XFileDataObject *object) const |
This is similar to repack_data(), except it is used to fill the initial values for a newly-created template object to zero. | |
XFileNode * | find_child (const string &name) const |
Returns the child with the indicated name, if any, or NULL if none. | |
int | find_child_index (const string &name) const |
Returns the index number of the child with the indicated name, if any, or -1 if none. | |
int | find_child_index (const XFileNode *child) const |
Returns the index number of the indicated child, or -1 if none. | |
XFileNode * | find_descendent (const string &name) const |
Returns the first child or descendent found with the indicated name after a depth-first search, if any, or NULL if none. | |
virtual TypeHandle | force_init_type () |
int | get_best_parent_from_Set (const std::set< int > &) const |
XFileNode * | get_child (int n) const |
Returns the nth child of this node. | |
virtual const WindowsGuid & | get_guid () const |
Returns the GUID associated with this template. | |
const string & | get_name () const |
int | get_num_children () const |
Returns the list of children of this node. | |
int | get_num_objects () const |
Returns the list of child objects of this node. | |
int | get_num_options () const |
Returns the number of templates on the options list. | |
XFileDataNode * | get_object (int n) const |
Returns the nth child object of this node. | |
bool | get_open () const |
Returns whether the template is considered "open" or not. | |
XFileTemplate * | get_option (int n) const |
Returns the nth template on the options list. | |
int | get_ref_count () const |
Returns the current reference count. | |
virtual TypeHandle | get_type () const |
int | get_type_index () const |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. | |
XFile * | get_x_file () const |
virtual bool | has_guid () const |
Returns true if this node has a GUID associated. | |
bool | has_name () const |
Returns true if the Namable has a nonempty name set, false if the name is empty. | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. | |
bool | is_exact_type (TypeHandle handle) const |
Returns true if the current object is the indicated type exactly. | |
virtual bool | is_object () const |
Returns true if this node represents a data object that is the instance of some template, or false otherwise. | |
bool | is_of_type (TypeHandle handle) const |
Returns true if the current object is or derives from the indicated type. | |
virtual bool | is_reference () const |
Returns true if this node represents an indirect reference to an object defined previously in the file. | |
bool | is_standard () const |
Returns true if this particular template is one of the "standard" templates defined by standardTemplates.x in this directory (and compiled into the binary), or false if it is a user-custom template. | |
virtual bool | is_standard_object (const string &template_name) const |
Returns true if this node represents an instance of the standard template with the indicated name, or false otherwise. | |
virtual bool | is_template_def () const |
Returns true if this node represents the definition of some template. | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. | |
virtual bool | matches (const XFileNode *other) const |
Returns true if the node, particularly a template node, is structurally equivalent to the other node (which must be of the same type). | |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr) |
void | operator delete (void *ptr) |
void | operator delete[] (void *, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *, void *) |
void * | operator new (size_t size) |
void * | operator new (size_t size, void *ptr) |
void * | operator new (size_t size, void *ptr) |
void * | operator new (size_t size) |
void * | operator new[] (size_t size) |
void * | operator new[] (size_t size) |
void * | operator new[] (size_t size, void *ptr) |
void * | operator new[] (size_t size, void *ptr) |
void | output (ostream &out) const |
Outputs the Namable. | |
void | ref () const |
Explicitly increments the reference count. | |
virtual bool | repack_data (XFileDataObject *object, const XFileParseDataList &parse_data_list, PrevData &prev_data, size_t &index, size_t &sub_index) const |
This is called on the template that defines an object, once the data for the object has been parsed. | |
void | set_name (const string &name) |
void | set_open (bool open) |
Sets whether the template is considered "open" or not. | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. | |
virtual bool | unref () const |
Explicitly decrements the reference count. | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. | |
virtual void | write_text (ostream &out, int indent_level) const |
Writes a suitable representation of this node to an .x file in text mode. | |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static void | init_type () |
This function is declared non-inline to work around a compiler bug in g++ 2.96. | |
static string | make_nice_name (const string &str) |
Transforms the indicated egg name to a name that is acceptable for a node in the X File format. | |
Protected Types | |
typedef pvector< PT(XFileNode) > | Children |
typedef pmap< string, int > | ChildrenByName |
typedef pvector< XFileDataNode * > | Objects |
Protected Member Functions | |
bool | do_test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | do_test_ref_count_nonzero () const |
Returns true if the reference count is nonzero, false otherwise. | |
Protected Attributes | |
Children | _children |
ChildrenByName | _children_by_name |
Objects | _objects |
XFile * | _x_file |
Friends | |
class | XFile |
A template definition in the X file.
This defines the data structures that may be subsequently read.
Definition at line 29 of file xFileTemplate.h.
void XFileNode::add_child | ( | XFileNode * | node | ) | [inherited] |
Adds the indicated node as a child of this node.
Definition at line 230 of file xFileNode.cxx.
References XFileNode::get_guid(), XFileNode::has_guid(), Namable::has_name(), and TypedObject::is_of_type().
Referenced by XFileNode::add_Frame(), XFileNode::add_FrameTransformMatrix(), XFileNode::add_Material(), XFileNode::add_Mesh(), XFileNode::add_MeshMaterialList(), XFileNode::add_MeshNormals(), XFileNode::add_MeshTextureCoords(), XFileNode::add_MeshVertexColors(), and XFileNode::add_TextureFilename().
XFileDataNode * XFileNode::add_Frame | ( | const string & | name | ) | [inherited] |
Creates a new Frame instance, as a child of this node.
Definition at line 499 of file xFileNode.cxx.
References XFileNode::add_child(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().
XFileDataNode * XFileNode::add_FrameTransformMatrix | ( | const LMatrix4d & | mat | ) | [inherited] |
Creates a new FrameTransformMatrix instance, as a child of this node.
Definition at line 517 of file xFileNode.cxx.
References XFileNode::add_child(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().
XFileDataNode * XFileNode::add_Material | ( | const string & | name, |
const Colorf & | face_color, | ||
double | power, | ||
const RGBColorf & | specular_color, | ||
const RGBColorf & | emissive_color | ||
) | [inherited] |
Creates a new Material instance, as a child of this node.
Definition at line 447 of file xFileNode.cxx.
References XFileNode::add_child(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().
Referenced by XFileMaterial::make_x_material().
XFileDataNode * XFileNode::add_Mesh | ( | const string & | name | ) | [inherited] |
Creates a new Mesh instance, as a child of this node.
Definition at line 357 of file xFileNode.cxx.
References XFileNode::add_child(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().
Referenced by XFileMesh::make_x_mesh().
XFileDataNode * XFileNode::add_MeshMaterialList | ( | const string & | name | ) | [inherited] |
Creates a new MeshMaterialList instance, as a child of this node.
Definition at line 429 of file xFileNode.cxx.
References XFileNode::add_child(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().
Referenced by XFileMesh::make_x_material_list().
XFileDataNode * XFileNode::add_MeshNormals | ( | const string & | name | ) | [inherited] |
Creates a new MeshNormals instance, as a child of this node.
Definition at line 375 of file xFileNode.cxx.
References XFileNode::add_child(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().
Referenced by XFileMesh::make_x_normals().
XFileDataNode * XFileNode::add_MeshTextureCoords | ( | const string & | name | ) | [inherited] |
Creates a new MeshTextureCoords instance, as a child of this node.
Definition at line 411 of file xFileNode.cxx.
References XFileNode::add_child(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().
Referenced by XFileMesh::make_x_uvs().
XFileDataNode * XFileNode::add_MeshVertexColors | ( | const string & | name | ) | [inherited] |
Creates a new MeshVertexColors instance, as a child of this node.
Definition at line 393 of file xFileNode.cxx.
References XFileNode::add_child(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().
Referenced by XFileMesh::make_x_colors().
void XFileTemplate::add_option | ( | XFileTemplate * | option | ) | [inline] |
Adds a new type to the list of allowable types of child nodes for an instance of this template.
Definition at line 65 of file xFileTemplate.I.
XFileDataNode * XFileNode::add_TextureFilename | ( | const string & | name, |
const Filename & | filename | ||
) | [inherited] |
Creates a new TextureFilename instance, as a child of this node.
Definition at line 479 of file xFileNode.cxx.
References XFileNode::add_child(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().
Referenced by XFileMaterial::make_x_material().
TypedObject * TypedObject::as_typed_object | ( | ) | [inline, inherited] |
Returns the object, upcast (if necessary) to a TypedObject pointer.
Definition at line 99 of file typedObject.I.
const TypedObject * TypedObject::as_typed_object | ( | ) | const [inline, inherited] |
Returns the object, upcast (if necessary) to a TypedObject pointer.
Definition at line 110 of file typedObject.I.
void XFileTemplate::clear | ( | void | ) | [virtual] |
Removes all children from the node, and otherwise resets it to its initial state.
Reimplemented from XFileNode.
Definition at line 89 of file xFileTemplate.cxx.
void Namable::clear_name | ( | ) | [inline, inherited] |
bool ReferenceCount::do_test_ref_count_integrity | ( | ) | const [protected, inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
Definition at line 29 of file referenceCount.cxx.
Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().
bool ReferenceCount::do_test_ref_count_nonzero | ( | ) | const [protected, inherited] |
Returns true if the reference count is nonzero, false otherwise.
Definition at line 56 of file referenceCount.cxx.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by ReferenceCount::test_ref_count_nonzero().
bool XFileNode::fill_zero_data | ( | XFileDataObject * | object | ) | const [virtual, inherited] |
This is similar to repack_data(), except it is used to fill the initial values for a newly-created template object to zero.
Reimplemented in XFileDataDef.
Definition at line 312 of file xFileNode.cxx.
XFileNode * XFileNode::find_child | ( | const string & | name | ) | const [inherited] |
Returns the child with the indicated name, if any, or NULL if none.
Definition at line 61 of file xFileNode.cxx.
References XFileNode::get_child().
Referenced by XFileNode::find_descendent(), and XFile::find_template().
int XFileNode::find_child_index | ( | const string & | name | ) | const [inherited] |
Returns the index number of the child with the indicated name, if any, or -1 if none.
Definition at line 78 of file xFileNode.cxx.
Referenced by XFileArrayDef::matches().
int XFileNode::find_child_index | ( | const XFileNode * | child | ) | const [inherited] |
Returns the index number of the indicated child, or -1 if none.
Definition at line 95 of file xFileNode.cxx.
XFileNode * XFileNode::find_descendent | ( | const string & | name | ) | const [inherited] |
Returns the first child or descendent found with the indicated name after a depth-first search, if any, or NULL if none.
Definition at line 113 of file xFileNode.cxx.
References XFileNode::find_child(), and XFileNode::find_descendent().
Referenced by XFile::find_data_object(), and XFileNode::find_descendent().
XFileNode * XFileNode::get_child | ( | int | n | ) | const [inline, inherited] |
Returns the nth child of this node.
This list includes templates as well as data objects.
Definition at line 44 of file xFileNode.I.
Referenced by XFileNode::find_child(), XFileDataNode::get_data_child(), and XFileNode::matches().
const WindowsGuid & XFileTemplate::get_guid | ( | ) | const [virtual] |
Returns the GUID associated with this template.
Reimplemented from XFileNode.
Definition at line 60 of file xFileTemplate.cxx.
Referenced by write_text().
int XFileNode::get_num_children | ( | ) | const [inline, inherited] |
Returns the list of children of this node.
This list includes templates as well as data objects.
Definition at line 33 of file xFileNode.I.
Referenced by XFileNode::matches().
int XFileNode::get_num_objects | ( | ) | const [inline, inherited] |
Returns the list of child objects of this node.
This list does not include template definitions; it is strictly the list of children that are also data objects (instances of templates).
Definition at line 58 of file xFileNode.I.
Referenced by XFileMaterial::fill_material(), XFileMesh::fill_material_list(), and XFileMesh::fill_mesh().
int XFileTemplate::get_num_options | ( | ) | const [inline] |
Returns the number of templates on the options list.
Definition at line 76 of file xFileTemplate.I.
XFileDataNode * XFileNode::get_object | ( | int | n | ) | const [inline, inherited] |
Returns the nth child object of this node.
This list does not include template definitions; it is strictly the list of children that are also data objects (instances of templates).
Definition at line 71 of file xFileNode.I.
Referenced by XFileMaterial::fill_material(), XFileMesh::fill_material_list(), and XFileMesh::fill_mesh().
bool XFileTemplate::get_open | ( | ) | const [inline] |
Returns whether the template is considered "open" or not.
If it is open (this flag is true), the set of options is ignored and the instances of this template may include any types of children. If it is closed (false), only the named types may be added.
Definition at line 54 of file xFileTemplate.I.
Referenced by write_text().
XFileTemplate * XFileTemplate::get_option | ( | int | n | ) | const [inline] |
Returns the nth template on the options list.
Definition at line 86 of file xFileTemplate.I.
int ReferenceCount::get_ref_count | ( | ) | const [inline, inherited] |
Returns the current reference count.
Definition at line 155 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by TransformState::clear_cache(), RenderState::clear_cache(), RenderState::finalize(), RenderEffects::finalize(), RenderEffect::finalize(), RenderAttrib::finalize(), InternalName::finalize(), TransformState::get_num_unused_states(), RenderState::get_num_unused_states(), TransformState::list_cycles(), RenderState::list_cycles(), GeomVertexFormat::remove_column(), TransformState::unref(), RenderState::unref(), RenderState::~RenderState(), and TransformState::~TransformState().
int TypedObject::get_type_index | ( | ) | const [inline, inherited] |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
This is equivalent to get_type().get_index().
Definition at line 52 of file typedObject.I.
References TypeHandle::get_index().
WeakReferenceList * ReferenceCount::get_weak_list | ( | ) | const [inline, inherited] |
Returns the WeakReferenceList associated with this ReferenceCount object.
If there has never been a WeakReferenceList associated with this object, creates one now.
Definition at line 307 of file referenceCount.I.
Referenced by ReferenceCount::weak_ref().
bool XFileTemplate::has_guid | ( | ) | const [virtual] |
Returns true if this node has a GUID associated.
Reimplemented from XFileNode.
Definition at line 50 of file xFileTemplate.cxx.
bool Namable::has_name | ( | ) | const [inline, inherited] |
Returns true if the Namable has a nonempty name set, false if the name is empty.
Definition at line 75 of file namable.I.
Referenced by XFileNode::add_child(), EggComponentData::add_name(), Texture::do_read_dds_file(), Texture::do_read_one(), Character::fillin(), EggGroupUniquifier::get_category(), EggXfmSAnim::optimize(), NodePathComponent::output(), AsyncTask::output(), EggNamedObject::output(), EggSAnimData::write(), EggPrimitive::write_body(), ParametricCurveCollection::write_egg(), ParametricCurve::write_egg(), EggNamedObject::write_header(), XFileDataNodeTemplate::write_text(), and XFileDataDef::write_text().
bool ReferenceCount::has_weak_list | ( | ) | const [inline, inherited] |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).
Definition at line 294 of file referenceCount.I.
Referenced by ReferenceCount::weak_unref().
static void XFileTemplate::init_type | ( | ) | [inline, static] |
This function is declared non-inline to work around a compiler bug in g++ 2.96.
Making it inline seems to cause problems in the optimizer.
Reimplemented from XFileNode.
Definition at line 65 of file xFileTemplate.h.
bool TypedObject::is_exact_type | ( | TypeHandle | handle | ) | const [inline, inherited] |
Returns true if the current object is the indicated type exactly.
Definition at line 74 of file typedObject.I.
References TypeHandle::get_name().
Referenced by GraphicsStateGuardian::async_reload_texture(), PortalNode::combine_with(), PandaNode::combine_with(), GeomNode::combine_with(), CollisionNode::combine_with(), Character::combine_with(), PGItem::cull_callback(), FactoryParams::get_param_of_type(), CollisionHandlerPusher::handle_entries(), SceneGraphReducer::r_flatten(), ConnectionWriter::send(), FltToEggLevelState::set_transform(), and VirtualFileSystem::unmount().
bool XFileNode::is_object | ( | ) | const [virtual, inherited] |
Returns true if this node represents a data object that is the instance of some template, or false otherwise.
This also returns true for references to objects (which are generally treated just like the objects themselves).
If this returns true, the node must be of type XFileDataNode (it is either an XFileDataNodeTemplate or an XFileDataNodeReference).
Reimplemented in XFileDataNode.
Definition at line 203 of file xFileNode.cxx.
bool TypedObject::is_of_type | ( | TypeHandle | handle | ) | const [inline, inherited] |
Returns true if the current object is or derives from the indicated type.
Definition at line 63 of file typedObject.I.
References TypeHandle::is_derived_from().
Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().
bool XFileNode::is_reference | ( | ) | const [virtual, inherited] |
Returns true if this node represents an indirect reference to an object defined previously in the file.
References are generally transparent, so in most cases you never need to call this, unless you actually need to differentiate between references and instances; you can simply use the reference node as if it were itself the object it references.
If this returns true, the node must be of type XFileDataNodeReference.
Reimplemented in XFileDataNodeReference.
Definition at line 185 of file xFileNode.cxx.
bool XFileTemplate::is_standard | ( | ) | const [inline] |
Returns true if this particular template is one of the "standard" templates defined by standardTemplates.x in this directory (and compiled into the binary), or false if it is a user-custom template.
Definition at line 26 of file xFileTemplate.I.
bool XFileNode::is_standard_object | ( | const string & | template_name | ) | const [virtual, inherited] |
Returns true if this node represents an instance of the standard template with the indicated name, or false otherwise.
This returns also returns true for references to standard objects.
If this returns true, the node must be of type XFileDataNode (it is either an XFileDataNodeTemplate or an XFileDataNodeReference).
Reimplemented in XFileDataNode.
Definition at line 220 of file xFileNode.cxx.
bool XFileTemplate::is_template_def | ( | ) | const [virtual] |
Returns true if this node represents the definition of some template.
This is the template definition, not an actual data object that represents an instance of the template. If the file strictly uses standard templates, the presence of template definitions is optional.
If this returns true, the node must be of type XFileTemplate.
Reimplemented from XFileNode.
Definition at line 78 of file xFileTemplate.cxx.
void ReferenceCount::local_object | ( | ) | [inline, inherited] |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.
Definition at line 276 of file referenceCount.I.
Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().
string XFileNode::make_nice_name | ( | const string & | str | ) | [static, inherited] |
Transforms the indicated egg name to a name that is acceptable for a node in the X File format.
Definition at line 557 of file xFileNode.cxx.
bool XFileTemplate::matches | ( | const XFileNode * | other | ) | const [virtual] |
Returns true if the node, particularly a template node, is structurally equivalent to the other node (which must be of the same type).
This checks data element types, but does not compare data element names.
Reimplemented from XFileNode.
Definition at line 144 of file xFileTemplate.cxx.
References XFileNode::matches().
Referenced by XFile::find_template(), and XFileDataDef::matches().
void Namable::output | ( | ostream & | out | ) | const [inline, inherited] |
Outputs the Namable.
This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.
Reimplemented in AnimBundle, AnimChannelFixed< SwitchType >, AnimChannelMatrixFixed, AnimControl, AnimGroup, PartBundle, CollisionNode, CollisionTraverser, ButtonNode, EggNamedObject, AsyncTask, AsyncTaskChain, AsyncTaskManager, AdaptiveLru, Material, SimpleLru, HermiteCurve, RopeNode, SheetNode, Fog, GeomNode, LensNode, Loader, PandaNode, PlaneNode, PolylightNode, PortalNode, CallbackNode, FadeLODNode, LODNode, ForceNode, Thread, MouseRecorder, TextNode, MouseWatcherRegion, WebcamVideo, and MayaShader.
void ReferenceCount::ref | ( | ) | const [inline, inherited] |
Explicitly increments the reference count.
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
Definition at line 179 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().
bool XFileNode::repack_data | ( | XFileDataObject * | object, |
const XFileParseDataList & | parse_data_list, | ||
XFileNode::PrevData & | prev_data, | ||
size_t & | index, | ||
size_t & | sub_index | ||
) | const [virtual, inherited] |
This is called on the template that defines an object, once the data for the object has been parsed.
It is responsible for identifying which component of the template owns each data element, and packing the data elements appropriately back into the object.
It returns true on success, or false on an error (e.g. not enough data elements, mismatched data type).
Reimplemented in XFileDataDef.
Definition at line 284 of file xFileNode.cxx.
void XFileTemplate::set_open | ( | bool | open | ) | [inline] |
Sets whether the template is considered "open" or not.
If it is open (this flag is true), the set of options is ignored and the instances of this template may include any types of children. If it is closed (false), only the named types may be added.
Definition at line 40 of file xFileTemplate.I.
bool ReferenceCount::test_ref_count_integrity | ( | ) | const [inline, inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
Definition at line 236 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by EggGroupNode::add_child(), InternalName::find_ancestor(), InternalName::get_ancestor(), ReferenceCount::get_ref_count(), InternalName::get_top(), ReferenceCount::ref(), EggVertex::test_gref_integrity(), EggVertex::test_pref_integrity(), EggNode::test_under_integrity(), EggPrimitive::test_vref_integrity(), EggGroup::test_vref_integrity(), MouseWatcher::throw_event_pattern(), ReferenceCount::unref(), and EggNode::update_under().
bool ReferenceCount::test_ref_count_nonzero | ( | ) | const [inline, inherited] |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
Returns true if ok, false otherwise.
Definition at line 252 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_nonzero().
Referenced by CopyOnWritePointer::test_ref_count_nonzero().
bool ReferenceCount::unref | ( | ) | const [inline, virtual, inherited] |
Explicitly decrements the reference count.
Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is true if the new reference count is nonzero, false if it is zero.
Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.
Definition at line 214 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().
void ReferenceCount::weak_ref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Adds the indicated PointerToVoid as a weak reference to this object.
Definition at line 321 of file referenceCount.I.
References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().
void ReferenceCount::weak_unref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Removes the indicated PointerToVoid as a weak reference to this object.
It must have previously been added via a call to weak_ref().
Definition at line 334 of file referenceCount.I.
References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().
void XFileTemplate::write_text | ( | ostream & | out, |
int | indent_level | ||
) | const [virtual] |
Writes a suitable representation of this node to an .x file in text mode.
Reimplemented from XFileNode.
Definition at line 101 of file xFileTemplate.cxx.
References get_guid(), and get_open().