dimeExtrusionEntity Class Reference

The dimeExtrusionEntity class is the superclass of all entity classes with extrusion data. More...

#include <dime/entities/ExtrusionEntity.h>

Inheritance diagram for dimeExtrusionEntity:

Public Member Functions
	dimeExtrusionEntity ()
virtual int	countRecords () const
const dimeVec3f &	getExtrusionDir () const
virtual bool	getRecord (const int groupcode, dimeParam &param, const int index=0) const
dxfdouble	getThickness () const
virtual bool	isOfType (const int thtypeid) const
void	setExtrusionDir (const dimeVec3f &v)
void	setThickness (const dxfdouble val)
virtual int	typeId () const
Public Member Functions inherited from dimeEntity
	dimeEntity ()
virtual	~dimeEntity ()
virtual dimeEntity *	copy (dimeModel *const model) const =0
virtual GeometryType	extractGeometry (dimeArray< dimeVec3f > &verts, dimeArray< int > &indices, dimeVec3f &extrusionDir, dxfdouble &thickness)
int16	getColorNumber () const
int16	getEntityFlags () const
virtual const char *	getEntityName () const =0
const dimeLayer *	getLayer () const
const char *	getLayerName () const
bool	isDeleted () 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)
virtual bool	write (dimeOutput *const out)
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
void	copyExtrusionData (const dimeExtrusionEntity *const entity)
virtual bool	handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
bool	writeExtrusionData (dimeOutput *const out)
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

Protected Attributes
dimeVec3f	extrusionDir
dxfdouble	thickness
Protected Attributes inherited from dimeRecordHolder
int	numRecords
dimeRecord **	records

Additional Inherited Members
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 }
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)

Detailed Description

The dimeExtrusionEntity class is the superclass of all entity classes with extrusion data.

Constructor & Destructor Documentation

dimeExtrusionEntity()

dimeExtrusionEntity::dimeExtrusionEntity

(

)

Constructor. Will initialize the extrusion direction to (0,0,1) and the thickness to 0.0.

Member Function Documentation

copyExtrusionData()

void dimeExtrusionEntity::copyExtrusionData ( const dimeExtrusionEntity *const entity )

protected

Copies all extrusion data from entity.

countRecords()

int dimeExtrusionEntity::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.

Reimplemented in dimeArc, dimeCircle, dimeEllipse, dimeLine, dimeLWPolyline, dimePoint, dimePolyline, and dimeText.

getExtrusionDir()

const dimeVec3f & dimeExtrusionEntity::getExtrusionDir ( ) const

inline

Returns the extrusion direction.

getRecord()

bool dimeExtrusionEntity::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.

Reimplemented in dimeLWPolyline, dimeArc, dimeCircle, dimeEllipse, dimeLine, dimePoint, dimePolyline, and dimeText.

getThickness()

dxfdouble dimeExtrusionEntity::getThickness ( ) const

inline

Returns the extrusion thickness.

handleRecord()

bool dimeExtrusionEntity::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.

Reimplemented in dimeArc, dimeCircle, dimeEllipse, dimeLine, dimeLWPolyline, dimePoint, dimePolyline, and dimeText.

isOfType()

bool dimeExtrusionEntity::isOfType ( const int thetypeid ) const

virtual

Returns true if the object is of type typeid or is inherited from it. Function in base class checks whether thetypeid equals the virtual dimeBase::typeId() value or equals dimeBaseType. Must be implemented by all subclasses that are superclasses of other classes, and should check if thetypeid equals its typeId, and then call its parent's isOfType function. Leaf-classes do not have to implement this method.

Reimplemented from dimeEntity.

setExtrusionDir()

void dimeExtrusionEntity::setExtrusionDir ( const dimeVec3f & v )

inline

Sets the extrusion direction. Default value is (0,0,1).

setThickness()

void dimeExtrusionEntity::setThickness ( const dxfdouble val )

inline

Sets the extrusion thickness. Default value is 0.0.

typeId()

int dimeExtrusionEntity::typeId ( ) const

virtual

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

Implements dimeBase.

Reimplemented in dimeArc, dimeCircle, dimeEllipse, dimeLine, dimeLWPolyline, dimePoint, dimePolyline, and dimeText.

writeExtrusionData()

bool dimeExtrusionEntity::writeExtrusionData ( dimeOutput *const file )

protected

Will write the extrusion and thickness records.

---

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

• ExtrusionEntity.h
• ExtrusionEntity.cpp