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

Public Member Functions | Protected Member Functions | List of all members
dimeSolid Class Reference

The dimeSolid class handles a SOLID entity. More...

`#include <dime/entities/Solid.h>`

Inheritance diagram for dimeSolid:

## Public Member Functions

| dimeSolid ()
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 dimeEntity * | copy (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 dimeVec3f & | getVertex (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 dimeLayer * | getLayer () 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)
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 | 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 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)
Protected Attributes inherited from dimeFaceEntity
dimeVec3f | coords [4]
Protected Attributes inherited from dimeRecordHolder
dimeRecord ** | records
int | numRecords

## Detailed Description

The dimeSolid class handles a SOLID entity.

## Constructor & Destructor Documentation

## ◆ dimeSolid()

dimeSolid::dimeSolid | ( |  | ) |

Constructor.

## Member Function Documentation

## ◆ copy()

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

References dimeFaceEntity::copyCoords(), dimeEntity::copyRecords(), and dimeModel::getMemHandler().

## ◆ countRecords()

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

References dimeFaceEntity::countRecords(), and dimeEntity::isDeleted().

## ◆ getEntityName()

const char * dimeSolid::getEntityName | ( |  | ) | const

virtual

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

Implements dimeEntity.

## ◆ getExtrusionDir()

void dimeSolid::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.

## ◆ getRecord()

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

References dimeFaceEntity::getRecord().

## ◆ getThickness()

dxfdouble dimeSolid::getThickness | ( |  | ) | const

virtual

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

Reimplemented from dimeFaceEntity.

## ◆ handleRecord()

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

References dimeFaceEntity::handleRecord().

## ◆ swapQuadCoords()

bool dimeSolid::swapQuadCoords | ( |  | ) | const

protected virtual

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

Reimplemented from dimeFaceEntity.

## ◆ typeId()

int dimeSolid::typeId | ( |  | ) | const

virtual

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

Reimplemented from dimeFaceEntity.

## ◆ write()

bool dimeSolid::write | ( | dimeOutput *const | file | ) |

virtual

Writes a SOLID entity.

Reimplemented from dimeEntity.

References dimeEntity::isDeleted(), dimeEntity::preWrite(), dimeEntity::write(), dimeFaceEntity::writeCoords(), dimeOutput::writeDouble(), and dimeOutput::writeGroupCode().

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

- Solid.h
- Solid.cpp

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