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

The dimeText class handles a Text entity. More...

#include <dime/entities/Text.h>

Inheritance diagram for dimeText:
dimeExtrusionEntity dimeEntity dimeRecordHolder dimeBase

Public Member Functions

 dimeText ()
 
void setOrigin (const dimeVec3f &o)
 
void getOrigin (dimeVec3f &o) const
 
void setSecond (const dimeVec3f &s)
 
bool getSecond (dimeVec3f &s) const
 
void setHeight (const dxfdouble h)
 
dxfdouble getHeight () const
 
void setWidth (const dxfdouble w)
 
dxfdouble getWidth () const
 
void setRotation (const dxfdouble a)
 
dxfdouble getRotation () const
 
void setHJust (const int32 h)
 
int32 getHJust () const
 
void setVJust (const int32 v)
 
int32 getVJust () const
 
void setTextString (const char *s)
 
char * getTextString () const
 
virtual bool getRecord (const int groupcode, dimeParam &param, const int index=0) const
 
virtual const char * getEntityName () const
 
virtual dimeEntitycopy (dimeModel *const model) const
 
virtual void print () const
 
virtual bool write (dimeOutput *const out)
 
virtual int typeId () const
 
virtual int countRecords () const
 
virtual GeometryType extractGeometry (dimeArray< dimeVec3f > &verts, dimeArray< int > &indices, dimeVec3f &extrusionDir, dxfdouble &thickness)
 
- Public Member Functions inherited from dimeExtrusionEntity
 dimeExtrusionEntity ()
 
void setExtrusionDir (const dimeVec3f &v)
 
const dimeVec3fgetExtrusionDir () const
 
void setThickness (const dxfdouble val)
 
dxfdouble getThickness () const
 
virtual bool isOfType (const int thtypeid) 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)
 
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 handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
 
- Protected Member Functions inherited from dimeExtrusionEntity
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
 

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 dimeExtrusionEntity
dimeVec3f extrusionDir
 
dxfdouble thickness
 
- Protected Attributes inherited from dimeRecordHolder
dimeRecord ** records
 
int numRecords
 

Detailed Description

The dimeText class handles a Text entity.

Constructor & Destructor Documentation

◆ dimeText()

dimeText::dimeText ( )

Constructor.

Member Function Documentation

◆ getRecord()

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

◆ getEntityName()

const char * dimeText::getEntityName ( ) const
virtual

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

Implements dimeEntity.

◆ copy()

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

◆ write()

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

Will write the records to file.

Reimplemented from dimeEntity.

◆ typeId()

int dimeText::typeId ( ) const
virtual

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

Reimplemented from dimeExtrusionEntity.

◆ countRecords()

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

◆ extractGeometry()

dimeEntity::GeometryType dimeText::extractGeometry ( dimeArray< dimeVec3f > &  verts,
dimeArray< int > &  indices,
dimeVec3f extrusionDir,
dxfdouble &  thickness 
)
virtual

A special convenience function, included for your pleasure. Enables the user to ignore the type of entity, and just call this method when extracting geometry. Very useful for 3D viewers that need DXF support. Check out the dxf2vrml directory for an example on how to convert a DXF file to VRML.

Should be overloaded by all subclasses that have geometry, default function returns no geometry. Don't forget to transform vertices by the current transformation matrix if used in a callback from dimeEntity::traverse().

If there are coordinates, but no indices, this means running indices for the entire vertex array.

Different faces and/or line segments are separated by a -1 in the indices array, just as in VRML files.

If thickness != 0.0, the data should, before transformation, be extruded by that length along the extrusion direction. Hence, a point becomes a line, a line becomes a quad, and a polygon becomes an object with a volume.

If thickness == 0.0 and extrusionDir != (0,0,1) all the vertices should be transformed by a matrix that can be created using dimeEntity::generateUCS(). If you are using dimeModel::traverseEntities() to extract the geometry, simply right-multiply the UCS matrix with the matrix found in dimeState to get the correct transformation.

Reimplemented from dimeEntity.

◆ handleRecord()

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


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