dimeVertex Class Reference

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

#include <dime/entities/Vertex.h>

Inheritance diagram for dimeVertex:

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 Types inherited from dimeEntity
enum	GeometryType { NONE , POLYGONS , LINES , POINTS }
Public Types inherited from dimeBase
enum	{   dimeBaseType = 1 , dimeRecordType , dimeStringRecordType , dimeFloatRecordType ,   dimeDoubleRecordType , dimeInt8RecordType , dimeInt16RecordType , dimeInt32RecordType ,   dimeHexRecordType , dimeRecordHolderType , dimeClassType , dimeUnknownClassType ,   dimeObjectType , dimeUnknownObjectType , dimeEntityType , dimeUnknownEntityType ,   dimePolylineType , dimeVertexType , dimeFaceEntityType , dimeExtrusionEntityType ,   dime3DFaceType , dimeSolidType , dimeTraceType , dimeLineType ,   dimeTextType , dimePointType , dimeBlockType , dimeInsertType ,   dimeCircleType , dimeArcType , dimeLWPolylineType , dimeEllipseType ,   dimeSplineType , dimeSectionType , dimeUnknownSectionType , dimeEntitiesSectionType ,   dimeBlocksSectionType , dimeTablesSectionType , dimeHeaderSectionType , dimeClassesSectionType ,   dimeObjectsSectionType , dimeTableType , dimeTableEntryType , dimeUnknownTableType ,   dimeUCSTableType , dimeLayerTableType , dimeLastTypeTag }

Public Member Functions
	dimeVertex ()
virtual dimeEntity *	copy (dimeModel *const model) const
virtual int	countRecords () const
const dimeVec3f &	getCoords () const
virtual const char *	getEntityName () const
int16	getFlags () const
int	getIndex (const int idx) const
virtual bool	getRecord (const int groupcode, dimeParam &param, const int index=0) const
int	numIndices () const
void	setCoords (const dimeVec3f &v)
void	setFlags (const int16 flags)
void	setIndex (const int idx, const int val)
virtual int	typeId () const
virtual bool	write (dimeOutput *const out)
Public Member Functions inherited from dimeEntity
	dimeEntity ()
virtual	~dimeEntity ()
virtual GeometryType	extractGeometry (dimeArray< dimeVec3f > &verts, dimeArray< int > &indices, dimeVec3f &extrusionDir, dxfdouble &thickness)
int16	getColorNumber () const
int16	getEntityFlags () const
const dimeLayer *	getLayer () const
const char *	getLayerName () const
bool	isDeleted () const
virtual bool	isOfType (const int thetypeid) const
bool	isTagged () const
virtual void	print () const
virtual bool	read (dimeInput *const in)
void	setColorNumber (const int16 c)
void	setDeleted (const bool onOff=true)
void	setEntityFlags (const int16 flags)
virtual void	setLayer (const dimeLayer *const layer)
void	setTagged (const bool onOff=true)
Public Member Functions inherited from dimeRecordHolder
	dimeRecordHolder (const int separator)
virtual	~dimeRecordHolder ()
dimeRecord *	findRecord (const int groupcode, const int index=0)
int	getNumRecordsInRecordHolder (void) const
dimeRecord *	getRecordInRecordHolder (const int idx) const
void	setIndexedRecord (const int groupcode, const dimeParam &value, const int index, dimeMemHandler *const memhandler=NULL)
void	setRecord (const int groupcode, const dimeParam &value, dimeMemHandler *const memhandler=NULL)
void	setRecords (const int *const groupcodes, const dimeParam *const params, const int numrecords, dimeMemHandler *const memhandler=NULL)
Public Member Functions inherited from dimeBase
	dimeBase (void)
virtual	~dimeBase ()
void	operator delete (void *ptr)
void *	operator new (size_t size, dimeMemHandler *memhandler=NULL, const int alignment=4)

Protected Member Functions
virtual bool	handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
Protected Member Functions inherited from dimeEntity
bool	copyRecords (dimeEntity *const entity, dimeModel *const model) const
virtual void	fixReferences (dimeModel *const model)
bool	preWrite (dimeOutput *const file)
virtual bool	shouldWriteRecord (const int groupcode) const
virtual bool	traverse (const dimeState *const state, dimeCallback callback, void *userdata)
Protected Member Functions inherited from dimeRecordHolder
bool	copyRecords (dimeRecordHolder *const rh, dimeMemHandler *const memhandler) const

Additional Inherited Members
Static Public Member Functions inherited from dimeEntity
static void	arbitraryAxis (const dimeVec3f &givenaxis, dimeVec3f &newaxis)
static bool	copyEntityArray (const dimeEntity *const *const array, const int nument, dimeModel *const model, dimeArray< dimeEntity * > &destarray)
static dimeEntity **	copyEntityArray (const dimeEntity *const *const array, int &nument, dimeModel *const model)
static dimeEntity *	createEntity (const char *const name, dimeMemHandler *const memhandler=NULL)
static void	generateUCS (const dimeVec3f &givenaxis, dimeMatrix &m)
static bool	readEntities (dimeInput *const file, dimeArray< dimeEntity * > &array, const char *const stopat)
Protected Attributes inherited from dimeRecordHolder
int	numRecords
dimeRecord **	records

Detailed Description

The dimeVertex class handles a VERTEX entity.

Constructor & Destructor Documentation

dimeVertex()

dimeVertex::dimeVertex

(

)

Constructor.

Member Function Documentation

copy()

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.

Implements dimeEntity.

countRecords()

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.

getEntityName()

const char * dimeVertex::getEntityName ( ) const

virtual

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

Implements dimeEntity.

getIndex()

int dimeVertex::getIndex

(

const int

num

)

const

Returns index number num.

getRecord()

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 group code queried is not stored internally, the subclass should call its parent's method.

Reimplemented from dimeEntity.

handleRecord()

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

protectedvirtual

Must be overloaded by entities that directly support 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.

numIndices()

int dimeVertex::numIndices

(

)

const

Returns the number of indices stored in this vertex.

typeId()

int dimeVertex::typeId ( ) const

virtual

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

Implements dimeBase.

write()

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:

• Vertex.h
• Vertex.cpp