Main Page   Class Hierarchy   Compound List   File List   Compound Members  

dimeVertex Class Reference

The dimeVertex class handles a VERTEX entity. More...

#include <dime/entities/Vertex.h>

Inheritance diagram for dimeVertex::

dimeEntity dimeRecordHolder dimeBase List of all members.

Public Types

enum  Flags {
  CURVE_FITTING_VERTEX = 0x01, HAS_CURVE_FIT_TANGENT = 0x02, SPLINE_VERTEX = 0x08, FRAME_CONTROL_POINT = 0x10,
  POLYLINE_3D_VERTEX = 0x20, POLYGON_MESH_VERTEX = 0x40, POLYFACE_MESH_VERTEX = 0x80
}

Public Methods

 dimeVertex ()
virtual dimeEntitycopy (dimeModel *const model) const
virtual bool getRecord (const int groupcode, dimeParam &param, const int index=0) const
virtual const char * getEntityName () const
int16 getFlags () const
void setFlags (const int16 flags)
void setCoords (const dimeVec3f &v)
const dimeVec3fgetCoords () const
int numIndices () const
int getIndex (const int idx) const
void setIndex (const int idx, const int val)
virtual bool write (dimeOutput *const out)
virtual int typeId () const
virtual int countRecords () const

Protected Methods

virtual bool handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)

Friends

class dimePolyline
class dimeEntity

Detailed Description

The dimeVertex class handles a VERTEX entity.


Constructor & Destructor Documentation

dimeVertex::dimeVertex  
 

Constructor.


Member Function Documentation

dimeEntity * dimeVertex::copy dimeModel *const    model const [virtual]
 

Must be implemented by subclasses to return a copy of the entity. model is the model the new entity should belong to.

Reimplemented from dimeEntity.

int dimeVertex::countRecords   const [virtual]
 

Returns the number of records in the record holder. Should be overloaded by subclasses which should count their records, and then call the parent's method. This method is used to precalculate the number of records to be written. Very useful when progress information is needed during write().

Reimplemented from dimeEntity.

const char * dimeVertex::getEntityName   const [virtual]
 

Must be implemented by subclasses to return the entity name; e.g. POLYLINE, 3DFACE, etc.

Reimplemented from dimeEntity.

int dimeVertex::getIndex const int    num const
 

Returns index number num;

bool dimeVertex::getRecord const int    groupcode,
dimeParam   param,
const int    index = 0
const [virtual]
 

Will return the value of the record with group code groupcode. false is returned if the record could not be found. Subclasses should overload this method if one or several records are stored in the class. If the groupcode queried is not stored internally, the subclass should call its parent's method.

Reimplemented from dimeEntity.

bool dimeVertex::handleRecord const int    groupcode,
const dimeParam   param,
dimeMemHandler *const    memhandler
[protected, virtual]
 

Must be overloaded by entities that directly supports a record type. During dimeRecordHolder::read(), dimeRecordHolder::setRecord and dimeRecordHolder::setRecords, this function is called for every record found, and it is up to the subclass if the record should be stored internally, or if a generic record should be created and stored in this superclass. A subclass should return \true when it will handle the record, false otherwise. Default function does nothing, and returns false.

For entities, records with group codes 8 (layer name) and 62 (color number) are automatically handled by the dimeEntity class.

See also:
dimeRecordHolder::read() , dimeRecordHolder::setRecord()

Reimplemented from dimeEntity.

int dimeVertex::numIndices   const
 

Returns the number of indices stored in this vertex;

int dimeVertex::typeId   const [virtual]
 

Must be implemented by all subclasses, and should return an unique id for that class.

Reimplemented from dimeBase.

bool dimeVertex::write dimeOutput *const    file [virtual]
 

Will write the records to file.

Reimplemented from dimeEntity.


The documentation for this class was generated from the following files:
Copyright © 1998-1999, Systems In Motion <sales@sim.no>. All rights reserved.
System documentation was generated using doxygen.