| http://www.coin3d.org/ http://www.kongsberg.com/kogt/

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 bool | getRecord (const int groupcode, dimeParam &param, const int index=0) const
void | setExtrusionDir (const dimeVec3f &v)
const dimeVec3f & | getExtrusionDir () const
void | setThickness (const dxfdouble val)
dxfdouble | getThickness () const
virtual int | typeId () const
virtual bool | isOfType (const int thtypeid) const
virtual int | countRecords () 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)
virtual const char * | getEntityName () const =0
const dimeLayer * | getLayer () const
const char * | getLayerName () const
virtual dimeEntity * | copy (dimeModel *const model) const =0
virtual bool | read (dimeInput *const in)
virtual bool | write (dimeOutput *const out)
virtual void | print () const
bool | isDeleted () const
void | setDeleted (const bool onOff=true)
bool | isTagged () const
void | setTagged (const bool onOff=true)
virtual GeometryType | extractGeometry (dimeArray< dimeVec3f > &verts, dimeArray< int > &indices, dimeVec3f &extrusionDir, dxfdouble &thickness)
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)
dimeRecord * | findRecord (const int groupcode, const int index=0)
int | getNumRecordsInRecordHolder (void) const
dimeRecord * | getRecordInRecordHolder (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 | handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
void | copyExtrusionData (const dimeExtrusionEntity *const entity)
bool | writeExtrusionData (dimeOutput *const out)
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

## Protected Attributes

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

## 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 dimeEntity * | createEntity (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)

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

Referenced by dimeLWPolyline::copy(), dimeLine::copy(), dimePoint::copy(), dimeCircle::copy(), dimeArc::copy(), dimeEllipse::copy(), dimeText::copy(), and dimePolyline::copy().

## ◆ 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 dimePolyline, dimeEllipse, dimeText, dimeArc, dimeCircle, dimeLine, dimePoint, and dimeLWPolyline.

References dimeEntity::countRecords().

Referenced by dimeLWPolyline::countRecords(), dimeLine::countRecords(), dimePoint::countRecords(), dimeCircle::countRecords(), dimeArc::countRecords(), dimeEllipse::countRecords(), and dimeText::countRecords().

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

Reimplemented from dimeEntity.

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

References dimeEntity::getRecord().

Referenced by dimeLWPolyline::getRecord(), dimeLine::getRecord(), dimePoint::getRecord(), dimeArc::getRecord(), dimeCircle::getRecord(), dimeText::getRecord(), dimeEllipse::getRecord(), and dimePolyline::getRecord().

## ◆ getThickness()

dxfdouble dimeExtrusionEntity::getThickness | ( |  | ) | const

inline

Returns the extrusion thickness.

## ◆ handleRecord()

bool dimeExtrusionEntity::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 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 dimePolyline, dimeText, dimeEllipse, dimeArc, dimeLWPolyline, dimeCircle, dimeLine, and dimePoint.

References dimeEntity::handleRecord().

Referenced by dimeLine::handleRecord(), dimePoint::handleRecord(), dimeCircle::handleRecord(), dimeLWPolyline::handleRecord(), dimeArc::handleRecord(), dimeEllipse::handleRecord(), dimeText::handleRecord(), and dimePolyline::handleRecord().

## ◆ 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.

References dimeEntity::isOfType().

## ◆ 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 dimePolyline, dimeEllipse, dimeText, dimeArc, dimeCircle, dimeLine, dimePoint, and dimeLWPolyline.

## ◆ writeExtrusionData()

bool dimeExtrusionEntity::writeExtrusionData | ( | dimeOutput *const | file | ) |

protected

Will write the extrusion and thickness records.

References dimeOutput::writeDouble(), and dimeOutput::writeGroupCode().

Referenced by dimeLWPolyline::write(), dimeLine::write(), dimePoint::write(), dimeCircle::write(), dimeArc::write(), dimeText::write(), dimeEllipse::write(), and dimePolyline::write().

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

- ExtrusionEntity.h
- ExtrusionEntity.cpp

Copyright © by Kongsberg Oil & Gas Technologies. All rights reserved.