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

The abstract base class for a number of different types of data elements that may be stored in the X file. More...

#include "xFileDataObject.h"

Inheritance diagram for XFileDataObject:
ReferenceCount MemoryBase XFileDataNode XFileDataObjectArray XFileDataObjectDouble XFileDataObjectInteger XFileDataObjectString XFileDataNodeReference XFileDataNodeTemplate

Public Member Functions

 XFileDataObject (const XFileDataDef *data_def=NULL)
 
XFileDataObjectadd_Coords2d (XFile *x_file, const LVecBase2d &coords)
 Appends a new Coords2d instance. More...
 
XFileDataObjectadd_double (double double_value)
 Appends a new floating-point value to the data object, if it makes sense to do so. More...
 
virtual bool add_element (XFileDataObject *element)
 Adds the indicated element as a nested data element, if this data object type supports it. More...
 
XFileDataObjectadd_IndexedColor (XFile *x_file, int index, const LColor &color)
 Appends a new IndexedColor instance. More...
 
XFileDataObjectadd_int (int int_value)
 Appends a new integer value to the data object, if it makes sense to do so. More...
 
XFileDataObjectadd_MeshFace (XFile *x_file)
 Appends a new MeshFace instance. More...
 
XFileDataObjectadd_string (const string &string_value)
 Appends a new string value to the data object, if it makes sense to do so. More...
 
XFileDataObjectadd_Vector (XFile *x_file, const LVecBase3d &vector)
 Appends a new Vector instance. More...
 
double d () const
 Unambiguously returns the object's representation as a double, or 0.0 if the object has no double representation. More...
 
virtual TypeHandle force_init_type ()
 
const XFileDataDefget_data_def () const
 Returns the data object that this object is represented by, if any, or NULL if there is none. More...
 
virtual TypeHandle get_type () const
 
virtual string get_type_name () const
 Returns a string that represents the type of object this data object represents. More...
 
int i () const
 Unambiguously returns the object's representation as an integer, or 0 if the object has no integer representation. More...
 
virtual bool is_complex_object () const
 Returns true if this kind of data object is a complex object that can hold nested data elements, false otherwise. More...
 
LMatrix4d mat4 () const
 Returns the object's representation as an LMatrix4d. More...
 
void operator= (int int_value)
 Stores the indicated integer value into the object, if it makes sense to do so. More...
 
void operator= (double double_value)
 Stores the indicated floating-point value into the object, if it makes sense to do so. More...
 
void operator= (const string &string_value)
 Stores the indicated string value into the object, if it makes sense to do so. More...
 
void operator= (const LVecBase2d &vec)
 Stores the indicated Vec2 value into the object, if it makes sense to do so. More...
 
void operator= (const LVecBase3d &vec)
 Stores the indicated Vec3 value into the object, if it makes sense to do so. More...
 
void operator= (const LVecBase4d &vec)
 Stores the indicated Vec4 value into the object, if it makes sense to do so. More...
 
void operator= (const LMatrix4d &mat)
 Stores the indicated Matrix value into the object, if it makes sense to do so. More...
 
const XFileDataObjectoperator[] (int n) const
 Returns the nth nested object within this object. More...
 
const XFileDataObjectoperator[] (const string &name) const
 Returns the named nested object within this object. More...
 
XFileDataObjectoperator[] (int n)
 Returns the nth nested object within this object. More...
 
XFileDataObjectoperator[] (const string &name)
 Returns the named nested object within this object. More...
 
virtual void output_data (ostream &out) const
 Writes a suitable representation of this node to an .x file in text mode. More...
 
string s () const
 Unambiguously returns the object's representation as a string, or empty string if the object has no string representation. More...
 
void set (int int_value)
 Stores the indicated integer value into the object, if it makes sense to do so. More...
 
void set (double double_value)
 Stores the indicated floating-point value into the object, if it makes sense to do so. More...
 
void set (const string &string_value)
 Stores the indicated string value into the object, if it makes sense to do so. More...
 
void set (const LVecBase2d &vec)
 Stores the indicated Vec2 value into the object, if it makes sense to do so. More...
 
void set (const LVecBase3d &vec)
 Stores the indicated Vec3 value into the object, if it makes sense to do so. More...
 
void set (const LVecBase4d &vec)
 Stores the indicated Vec4 value into the object, if it makes sense to do so. More...
 
void set (const LMatrix4d &mat)
 Stores the indicated Matrix value into the object, if it makes sense to do so. More...
 
int size () const
 Returns the number of nested data objects within this object. More...
 
LVecBase2d vec2 () const
 Returns the object's representation as an LVecBase2d. More...
 
LVecBase3d vec3 () const
 Returns the object's representation as an LVecBase3d. More...
 
LVecBase4d vec4 () const
 Returns the object's representation as an LVecBase4d. More...
 
virtual void write_data (ostream &out, int indent_level, const char *separator) const
 Writes a suitable representation of this node to an .x file in text mode. More...
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Detailed Description

The abstract base class for a number of different types of data elements that may be stored in the X file.

Definition at line 33 of file xFileDataObject.h.

Member Function Documentation

◆ add_Coords2d()

XFileDataObject & XFileDataObject::add_Coords2d ( XFile x_file,
const LVecBase2d coords 
)

Appends a new Coords2d instance.

Definition at line 169 of file xFileDataObject.cxx.

References add_element(), XFile::find_standard_template(), set(), and XFileDataNodeTemplate::zero_fill().

Referenced by add_IndexedColor(), and XFileMesh::make_x_uvs().

◆ add_double()

XFileDataObject & XFileDataObject::add_double ( double  double_value)

Appends a new floating-point value to the data object, if it makes sense to do so.

Normally, this is valid only for a DataObjectArray, or in certain special cases for a DataNodeTemplate.

Definition at line 84 of file xFileDataObject.cxx.

References add_element(), add_string(), and get_data_def().

Referenced by add_int().

◆ add_element()

bool XFileDataObject::add_element ( XFileDataObject element)
virtual

Adds the indicated element as a nested data element, if this data object type supports it.

Returns true if added successfully, false if the data object type does not support nested data elements.

Reimplemented in XFileDataNodeTemplate, and XFileDataObjectArray.

Definition at line 191 of file xFileDataObject.cxx.

References output_data().

Referenced by add_Coords2d(), add_double(), add_IndexedColor(), add_int(), add_MeshFace(), add_string(), add_Vector(), and XFileDataDef::matches().

◆ add_IndexedColor()

XFileDataObject & XFileDataObject::add_IndexedColor ( XFile x_file,
int  index,
const LColor color 
)

Appends a new IndexedColor instance.

Definition at line 149 of file xFileDataObject.cxx.

References add_Coords2d(), add_element(), XFile::find_standard_template(), and XFileDataNodeTemplate::zero_fill().

Referenced by add_MeshFace(), and XFileMesh::make_x_colors().

◆ add_int()

XFileDataObject & XFileDataObject::add_int ( int  int_value)

Appends a new integer value to the data object, if it makes sense to do so.

Normally, this is valid only for a DataObjectArray, or in certain special cases for a DataNodeTemplate.

Definition at line 68 of file xFileDataObject.cxx.

References add_double(), add_element(), and get_data_def().

Referenced by get_type_name(), XFileMesh::make_x_material_list(), XFileMesh::make_x_mesh(), and XFileMesh::make_x_normals().

◆ add_MeshFace()

XFileDataObject & XFileDataObject::add_MeshFace ( XFile x_file)

◆ add_string()

XFileDataObject & XFileDataObject::add_string ( const string &  string_value)

Appends a new string value to the data object, if it makes sense to do so.

Normally, this is valid only for a DataObjectArray, or in certain special cases for a DataNodeTemplate.

Definition at line 100 of file xFileDataObject.cxx.

References add_element(), add_Vector(), and get_data_def().

Referenced by add_double().

◆ add_Vector()

XFileDataObject & XFileDataObject::add_Vector ( XFile x_file,
const LVecBase3d vector 
)

◆ d()

double XFileDataObject::d ( ) const
inline

Unambiguously returns the object's representation as a double, or 0.0 if the object has no double representation.

See also get_data_def() to determine what kind of representation this object has.

Definition at line 240 of file xFileDataObject.I.

References s().

Referenced by XFileMesh::fill_skin_weights(), and i().

◆ get_data_def()

const XFileDataDef * XFileDataObject::get_data_def ( ) const
inline

Returns the data object that this object is represented by, if any, or NULL if there is none.

Definition at line 34 of file xFileDataObject.I.

References operator=().

Referenced by add_double(), add_int(), and add_string().

◆ get_type_name()

string XFileDataObject::get_type_name ( ) const
virtual

Returns a string that represents the type of object this data object represents.

Reimplemented in XFileDataNode.

Definition at line 55 of file xFileDataObject.cxx.

References add_int(), and TypeHandle::get_name().

Referenced by is_complex_object(), and write_data().

◆ i()

int XFileDataObject::i ( ) const
inline

Unambiguously returns the object's representation as an integer, or 0 if the object has no integer representation.

See also get_data_def() to determine what kind of representation this object has.

Definition at line 227 of file xFileDataObject.I.

References d().

Referenced by XFileMesh::fill_colors(), XFileMesh::fill_material_list(), XFileMesh::fill_mesh(), XFileMesh::fill_normals(), XFileMesh::fill_skin_weights(), XFileNode::find_child_index(), XFileToEggConverter::find_joint(), XFileNode::matches(), set(), XFileDataObjectArray::write_data(), XFileDataNodeTemplate::write_data(), and write_data().

◆ is_complex_object()

bool XFileDataObject::is_complex_object ( ) const
virtual

Returns true if this kind of data object is a complex object that can hold nested data elements, false otherwise.

Reimplemented in XFileDataNodeTemplate, XFileDataNodeReference, and XFileDataObjectArray.

Definition at line 44 of file xFileDataObject.cxx.

References get_type_name().

Referenced by XFileDataObjectArray::write_data(), and XFileDataNodeTemplate::write_data().

◆ mat4()

LMatrix4d XFileDataObject::mat4 ( ) const
inline

Returns the object's representation as an LMatrix4d.

It is an error if the object does not have sixteen nested objects that store a double value.

Definition at line 307 of file xFileDataObject.I.

References size().

Referenced by XFileToEggConverter::find_joint(), and vec4().

◆ operator=() [1/7]

void XFileDataObject::operator= ( int  int_value)
inline

Stores the indicated integer value into the object, if it makes sense to do so.

It is an error to call this on an object that cannot accept an integer value.

Definition at line 46 of file xFileDataObject.I.

Referenced by get_data_def(), and operator=().

◆ operator=() [2/7]

void XFileDataObject::operator= ( double  double_value)
inline

Stores the indicated floating-point value into the object, if it makes sense to do so.

It is an error to call this on an object that cannot accept a floating-point value.

Definition at line 59 of file xFileDataObject.I.

References operator=().

◆ operator=() [3/7]

void XFileDataObject::operator= ( const string &  string_value)
inline

Stores the indicated string value into the object, if it makes sense to do so.

It is an error to call this on an object that cannot accept a string value.

Definition at line 72 of file xFileDataObject.I.

References operator=().

◆ operator=() [4/7]

void XFileDataObject::operator= ( const LVecBase2d vec)
inline

Stores the indicated Vec2 value into the object, if it makes sense to do so.

It is an error to call this on an object that does not store two floating-point values.

Definition at line 85 of file xFileDataObject.I.

References operator=().

◆ operator=() [5/7]

void XFileDataObject::operator= ( const LVecBase3d vec)
inline

Stores the indicated Vec3 value into the object, if it makes sense to do so.

It is an error to call this on an object that does not store three floating-point values.

Definition at line 98 of file xFileDataObject.I.

References operator=().

◆ operator=() [6/7]

void XFileDataObject::operator= ( const LVecBase4d vec)
inline

Stores the indicated Vec4 value into the object, if it makes sense to do so.

It is an error to call this on an object that does not store four floating-point values.

Definition at line 111 of file xFileDataObject.I.

References operator=().

◆ operator=() [7/7]

void XFileDataObject::operator= ( const LMatrix4d mat)
inline

Stores the indicated Matrix value into the object, if it makes sense to do so.

It is an error to call this on an object that does not store sixteen floating-point values.

Definition at line 124 of file xFileDataObject.I.

References set().

◆ operator[]() [1/4]

const XFileDataObject & XFileDataObject::operator[] ( int  n) const
inline

Returns the nth nested object within this object.

Call get_num_children() to determine the number of nested objects.

Definition at line 332 of file xFileDataObject.I.

Referenced by operator[](), and size().

◆ operator[]() [2/4]

const XFileDataObject & XFileDataObject::operator[] ( const string &  name) const
inline

Returns the named nested object within this object.

It is an error if the named object does not exist. Call find_child() instead if there is any doubt.

Definition at line 346 of file xFileDataObject.I.

References operator[]().

◆ operator[]() [3/4]

XFileDataObject & XFileDataObject::operator[] ( int  n)
inline

Returns the nth nested object within this object.

Call get_num_children() to determine the number of nested objects.

Definition at line 360 of file xFileDataObject.I.

References operator[]().

◆ operator[]() [4/4]

XFileDataObject & XFileDataObject::operator[] ( const string &  name)
inline

Returns the named nested object within this object.

It is an error if the named object does not exist. Call find_child() instead if there is any doubt.

Definition at line 374 of file xFileDataObject.I.

References output_data().

◆ output_data()

void XFileDataObject::output_data ( ostream &  out) const
virtual

Writes a suitable representation of this node to an .x file in text mode.

Reimplemented in XFileDataObjectDouble, XFileDataObjectInteger, and XFileDataObjectString.

Definition at line 202 of file xFileDataObject.cxx.

References write_data().

Referenced by add_element(), and operator[]().

◆ s()

string XFileDataObject::s ( ) const
inline

Unambiguously returns the object's representation as a string, or empty string if the object has no string representation.

See also get_data_def() to determine what kind of representation this object has.

Definition at line 253 of file xFileDataObject.I.

References vec2().

Referenced by d().

◆ set() [1/7]

void XFileDataObject::set ( int  int_value)
inline

Stores the indicated integer value into the object, if it makes sense to do so.

It is an error to call this on an object that cannot accept an integer value.

Definition at line 136 of file xFileDataObject.I.

Referenced by add_Coords2d(), add_Vector(), operator=(), and set().

◆ set() [2/7]

void XFileDataObject::set ( double  double_value)
inline

Stores the indicated floating-point value into the object, if it makes sense to do so.

It is an error to call this on an object that cannot accept a floating-point value.

Definition at line 149 of file xFileDataObject.I.

References set().

◆ set() [3/7]

void XFileDataObject::set ( const string &  string_value)
inline

Stores the indicated string value into the object, if it makes sense to do so.

It is an error to call this on an object that cannot accept a string value.

Definition at line 162 of file xFileDataObject.I.

References set().

◆ set() [4/7]

void XFileDataObject::set ( const LVecBase2d vec)
inline

Stores the indicated Vec2 value into the object, if it makes sense to do so.

It is an error to call this on an object that does not store two floating-point values.

Definition at line 175 of file xFileDataObject.I.

References LVecBase2d::get_data(), and set().

◆ set() [5/7]

void XFileDataObject::set ( const LVecBase3d vec)
inline

Stores the indicated Vec3 value into the object, if it makes sense to do so.

It is an error to call this on an object that does not store three floating-point values.

Definition at line 188 of file xFileDataObject.I.

References LVecBase3d::get_data(), and set().

◆ set() [6/7]

void XFileDataObject::set ( const LVecBase4d vec)
inline

Stores the indicated Vec4 value into the object, if it makes sense to do so.

It is an error to call this on an object that does not store four floating-point values.

Definition at line 201 of file xFileDataObject.I.

References LVecBase4d::get_data(), and set().

◆ set() [7/7]

void XFileDataObject::set ( const LMatrix4d mat)
inline

Stores the indicated Matrix value into the object, if it makes sense to do so.

It is an error to call this on an object that does not store sixteen floating-point values.

Definition at line 214 of file xFileDataObject.I.

References LMatrix4d::get_data(), and i().

◆ size()

int XFileDataObject::size ( ) const
inline

◆ vec2()

LVecBase2d XFileDataObject::vec2 ( ) const
inline

Returns the object's representation as an LVecBase2d.

It is an error if the object does not have two nested objects that store a double value.

Definition at line 265 of file xFileDataObject.I.

References vec3().

Referenced by XFileMesh::fill_uvs(), and s().

◆ vec3()

LVecBase3d XFileDataObject::vec3 ( ) const
inline

Returns the object's representation as an LVecBase3d.

It is an error if the object does not have three nested objects that store a double value.

Definition at line 279 of file xFileDataObject.I.

References vec4().

Referenced by XFileMesh::fill_mesh(), XFileMesh::fill_normals(), XFileToEggConverter::find_joint(), and vec2().

◆ vec4()

LVecBase4d XFileDataObject::vec4 ( ) const
inline

Returns the object's representation as an LVecBase4d.

It is an error if the object does not have four nested objects that store a double value.

Definition at line 293 of file xFileDataObject.I.

References mat4().

Referenced by XFileToEggConverter::find_joint(), and vec3().

◆ write_data()

void XFileDataObject::write_data ( ostream &  out,
int  indent_level,
const char *  separator 
) const
virtual

Writes a suitable representation of this node to an .x file in text mode.

Reimplemented in XFileDataNodeTemplate, XFileDataObjectArray, XFileDataObjectDouble, XFileDataObjectInteger, and XFileDataObjectString.

Definition at line 213 of file xFileDataObject.cxx.

References get_type_name(), and i().

Referenced by output_data(), and XFileDataNodeTemplate::write_data().


The documentation for this class was generated from the following files: