Main Page   Class Hierarchy   Compound List   File List   Compound Members  

dimeInsert Class Reference

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

#include <dime/entities/Insert.h>

Inheritance diagram for dimeInsert::

dimeEntity dimeRecordHolder dimeBase List of all members.

Public Methods

 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

Protected Methods

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)

Friends

class dimeEntitiesSection
class dimeBlocksSection

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.

Reimplemented from dimeEntity.

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.

void dimeInsert::fixReferences dimeModel *const    model [protected, virtual]
 

Used to find all forward references.

See also:
dimeEntitiesSection::fixReferences().

Reimplemented from dimeEntity.

const char * dimeInsert::getEntityName   const [virtual]
 

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

Reimplemented from 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
[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 \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 dimeEntity.

bool dimeInsert::read dimeInput *const    file [virtual]
 

Reads an INSERT entity.

Reimplemented from dimeEntity.

void dimeInsert::setBlock dimeBlock *const    block
 

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

bool dimeInsert::traverse const dimeState *const    state,
dimeCallback    callback,
void *    userdata
[protected, virtual]
 

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.

int dimeInsert::typeId   const [virtual]
 

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

Reimplemented from dimeBase.

bool dimeInsert::write dimeOutput *const    file [virtual]
 

Writes an INSERT entity.

Reimplemented from dimeEntity.


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.