Public Member Functions | Protected Member Functions | Friends | List of all members
dimeInsert Class Reference

The dimeInsert class handles an INSERT entity. More...

#include <dime/entities/Insert.h>

Inheritance diagram for dimeInsert:
dimeEntity dimeRecordHolder dimeBase

Public Member Functions

 dimeInsert ()
virtual ~dimeInsert ()
void setBlock (dimeBlock *const block)
dimeBlockgetBlock () 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 bool read (dimeInput *const in)
virtual bool write (dimeOutput *const out)
virtual int typeId () const
virtual int countRecords () const
void setInsertionPoint (const dimeVec3f &v)
const dimeVec3fgetInsertionPoint () const
void setScale (const dimeVec3f &v)
const dimeVec3fgetScale () const
void setRotAngle (dxfdouble angle)
dxfdouble getRotAngle () 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 isOfType (const int thetypeid) const
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)
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 void fixReferences (dimeModel *const model)
virtual bool handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
virtual bool traverse (const dimeState *const state, dimeCallback callback, void *userdata)
- Protected Member Functions inherited from dimeEntity
bool preWrite (dimeOutput *const file)
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

Friends

class dimeEntitiesSection
class dimeBlocksSection

Additional Inherited Members

- Public Types inherited from dimeEntity
enum  GeometryType { NONE, POLYGONS, LINES, POINTS }
- 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 dimeRecordHolder
dimeRecord ** records
int numRecords

Detailed Description

The dimeInsert class handles an INSERT entity.

Constructor & Destructor Documentation

dimeInsert::dimeInsert ( )

Constructor.

dimeInsert::~dimeInsert ( )
virtual

Destructor.

Member Function Documentation

dimeEntity * dimeInsert::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 dimeModel::addReference(), dimeEntity::copy(), dimeEntity::copyEntityArray(), dimeEntity::copyRecords(), dimeModel::findReference(), dimeModel::findRefStringPtr(), and dimeModel::getMemHandler().

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

References dimeEntity::countRecords().

void dimeInsert::fixReferences ( dimeModel *const  model)
protectedvirtual

Used to find all forward references.

See Also
dimeEntitiesSection::fixReferences().

Reimplemented from dimeEntity.

References dimeModel::findReference().

const char * dimeInsert::getEntityName ( ) const
virtual

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

Implements dimeEntity.

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

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

bool dimeInsert::read ( dimeInput *const  file)
virtual
void dimeInsert::setBlock ( dimeBlock *const  block)

Sets the block for this INSERT entity. This will change the record with group code 2.

References dimeBlock::getName().

bool dimeInsert::traverse ( const dimeState *const  state,
dimeCallback  callback,
void *  userdata 
)
protectedvirtual

The traversal function used when dimeModel::traverseEntities() is called. Most entities use this default method, but some entities (INSERT, BUILD) will need to overload it.

Reimplemented from dimeEntity.

References dimeEntity::isDeleted(), and dimeBlock::traverse().

int dimeInsert::typeId ( ) const
virtual

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

Implements dimeBase.

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

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

Copyright © 1998-1999, Systems In Motion <sales@sim.no>. All rights reserved.
System documentation was generated using doxygen.