PLY reader/writer  1.2.0
 All Classes Namespaces Functions Variables Enumerations Enumerator
Public Member Functions | List of all members
PLY::Object Struct Referenceabstract

The basis for an Object containing some data. More...

#include <object.h>

Inheritance diagram for PLY::Object:
PLY::AnyObject PLY::Face PLY::Vertex

Public Member Functions

virtual void prepare (const Element &elem)
 Prepare the Object to represent an Element. More...
 
virtual Valueget_value (const Element &elem, const Property &prop)=0
 Get a Value. More...
 
virtual bool make_element (Element &elem) const
 Construct an Element describing this Object. More...
 
bool describe_element (Header &header) const
 Add an Element describing this Object to a Header. More...
 
bool storage_test (const Element &elem)
 Check if the Object matches with an Element. More...
 

Detailed Description

The basis for an Object containing some data.

Note that an Element describes how the Object should be interpreted.

Member Function Documentation

bool PLY::Object::describe_element ( Header header) const

Add an Element describing this Object to a Header.

Parameters
[in,out]headerthe header to add the new Element to.
Returns
true if the Element could be constructed.
virtual Value* PLY::Object::get_value ( const Element elem,
const Property prop 
)
pure virtual

Get a Value.

Parameters
elemthe Element describing the Object.
propthe Property describing the Value.
Returns
the Value or NULL if the Value is not contained in this Object.

Implemented in PLY::Face, PLY::AnyObject, and PLY::Vertex.

virtual bool PLY::Object::make_element ( Element elem) const
inlinevirtual

Construct an Element describing this Object.

Note that this is only meant for user-constructed Objects to get the Element easily.

Parameters
[out]elemthe constructed Element.
Returns
true if the Element could be constructed.

Reimplemented in PLY::Face, and PLY::Vertex.

virtual void PLY::Object::prepare ( const Element elem)
inlinevirtual

Prepare the Object to represent an Element.

Parameters
elemthe Element to prepare for.

Reimplemented in PLY::AnyObject.

bool PLY::Object::storage_test ( const Element elem)

Check if the Object matches with an Element.

Note that this method changes the values of the Object.

Parameters
elemthe Element to compare to.
Returns
true if the Object could store the Element.

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