Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
dimeTrace Class Reference

The dimeTrace class handles a TRACE entity. More...

#include <dime/entities/Trace.h>

Inheritance diagram for dimeTrace:
dimeFaceEntity dimeEntity dimeRecordHolder dimeBase

Public Member Functions

 dimeTrace ()
 
virtual dxfdouble getThickness () const
 
virtual void getExtrusionDir (dimeVec3f &ed) const
 
void setThickness (const dxfdouble &thickness)
 
void setExtrusionDir (const dimeVec3f &ed)
 
virtual bool write (dimeOutput *const out)
 
virtual int typeId () const
 
virtual dimeEntitycopy (dimeModel *const model) const
 
virtual bool getRecord (const int groupcode, dimeParam &param, const int index=0) const
 
virtual const char * getEntityName () const
 
virtual int countRecords () const
 
- Public Member Functions inherited from dimeFaceEntity
bool isQuad () const
 
void setVertex (const int idx, const dimeVec3f &v)
 
void setTriangle (const dimeVec3f &v0, const dimeVec3f &v1, const dimeVec3f &v2)
 
void setQuad (const dimeVec3f &v0, const dimeVec3f &v1, const dimeVec3f &v2, const dimeVec3f &v3)
 
const dimeVec3fgetVertex (const int idx) const
 
void getVertices (dimeVec3f &v0, dimeVec3f &v1, dimeVec3f &v2, dimeVec3f &v3) const
 
GeometryType extractGeometry (dimeArray< dimeVec3f > &verts, dimeArray< int > &indices, dimeVec3f &extrusionDir, dxfdouble &thickness)
 
virtual bool isOfType (const int thetypeid) const
 
- Public Member Functions inherited from dimeEntity
 dimeEntity ()
 
virtual ~dimeEntity ()
 
int16 getEntityFlags () const
 
void setEntityFlags (const int16 flags)
 
int16 getColorNumber () const
 
void setColorNumber (const int16 c)
 
virtual void setLayer (const dimeLayer *const layer)
 
const dimeLayergetLayer () const
 
const char * getLayerName () const
 
virtual bool read (dimeInput *const in)
 
virtual void print () const
 
bool isDeleted () const
 
void setDeleted (const bool onOff=true)
 
bool isTagged () const
 
void setTagged (const bool onOff=true)
 
- Public Member Functions inherited from dimeRecordHolder
 dimeRecordHolder (const int separator)
 
virtual ~dimeRecordHolder ()
 
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)
 
void setIndexedRecord (const int groupcode, const dimeParam &value, const int index, dimeMemHandler *const memhandler=NULL)
 
dimeRecordfindRecord (const int groupcode, const int index=0)
 
int getNumRecordsInRecordHolder (void) const
 
dimeRecordgetRecordInRecordHolder (const int idx) const
 
- Public Member Functions inherited from dimeBase
 dimeBase (void)
 
virtual ~dimeBase ()
 
void * operator new (size_t size, dimeMemHandler *memhandler=NULL, const int alignment=4)
 
void operator delete (void *ptr)
 

Protected Member Functions

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

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 dimeEntitycreateEntity (const char *const name, dimeMemHandler *const memhandler=NULL)
 
static bool readEntities (dimeInput *const file, dimeArray< dimeEntity *> &array, const char *const stopat)
 
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 void arbitraryAxis (const dimeVec3f &givenaxis, dimeVec3f &newaxis)
 
static void generateUCS (const dimeVec3f &givenaxis, dimeMatrix &m)
 
- Protected Attributes inherited from dimeFaceEntity
dimeVec3f coords [4]
 
- Protected Attributes inherited from dimeRecordHolder
dimeRecord ** records
 
int numRecords
 

Detailed Description

The dimeTrace class handles a TRACE entity.

Constructor & Destructor Documentation

◆ dimeTrace()

dimeTrace::dimeTrace ( )

Constructor.

Member Function Documentation

◆ getThickness()

dxfdouble dimeTrace::getThickness ( ) const
virtual

Default method return 0.0. Should be overloaded if this is not correct for all cases.

Reimplemented from dimeFaceEntity.

◆ getExtrusionDir()

void dimeTrace::getExtrusionDir ( dimeVec3f ed) const
virtual

Default method returns (0,0,1). Should be overloaded if this is not correct for all cases.

Reimplemented from dimeFaceEntity.

◆ write()

bool dimeTrace::write ( dimeOutput *const  file)
virtual

Will write the records to file.

Reimplemented from dimeEntity.

◆ typeId()

int dimeTrace::typeId ( ) const
virtual

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

Reimplemented from dimeFaceEntity.

◆ copy()

dimeEntity * dimeTrace::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.

◆ getRecord()

bool dimeTrace::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 dimeFaceEntity.

◆ getEntityName()

const char * dimeTrace::getEntityName ( ) const
virtual

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

Implements dimeEntity.

◆ countRecords()

int dimeTrace::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 dimeFaceEntity.

◆ swapQuadCoords()

bool dimeTrace::swapQuadCoords ( ) const
protectedvirtual

Default function returns false. If true is returned, the last two vertices will be swapped before returning geometry in extractGeometry().

Reimplemented from dimeFaceEntity.

◆ handleRecord()

bool dimeTrace::handleRecord ( const int  groupcode,
const dimeParam param,
dimeMemHandler *const  memhandler 
)
protectedvirtual

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 dimeFaceEntity.


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