Main Page | Class Hierarchy | Compound List | File List | Compound Members

dimeFaceEntity Class Reference

The dimeFaceEntity class is an abstract class that handles one-face entity classes. More...

#include <dime/entities/FaceEntity.h>

Inheritance diagram for dimeFaceEntity:

dimeEntity dimeRecordHolder dimeBase dime3DFace dimeSolid dimeTrace List of all members.

Public Member Functions

bool isQuad () const
virtual bool getRecord (const int groupcode, dimeParam &param, const int index=0) 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 dimeVec3fgetVertex (const int idx) const
void getVertices (dimeVec3f &v0, dimeVec3f &v1, dimeVec3f &v2, dimeVec3f &v3) const
virtual dxfdouble getThickness () const
virtual void getExtrusionDir (dimeVec3f &ed) const
GeometryType extractGeometry (dimeArray< dimeVec3f > &verts, dimeArray< int > &indices, dimeVec3f &extrusionDir, dxfdouble &thickness)
virtual int typeId () const
virtual bool isOfType (const int thetypeid) const
virtual int countRecords () const

Protected Member Functions

virtual bool swapQuadCoords () const
virtual bool handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
void copyCoords (const dimeFaceEntity *const entity)
bool writeCoords (dimeOutput *const file)

Protected Attributes

dimeVec3f coords [4]

Detailed Description

The dimeFaceEntity class is an abstract class that handles one-face entity classes.


Member Function Documentation

void dimeFaceEntity::copyCoords const dimeFaceEntity *const  entity  )  [protected]
 

Copies the coordinates from entity.

int dimeFaceEntity::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 dime3DFace, dimeSolid, and dimeTrace.

dimeEntity::GeometryType dimeFaceEntity::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.

void dimeFaceEntity::getExtrusionDir dimeVec3f ed  )  const [virtual]
 

Default method returns (0,0,1). Should be overloaded if this is not correct for all cases.

Reimplemented in dimeSolid, and dimeTrace.

bool dimeFaceEntity::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 dime3DFace, dimeSolid, and dimeTrace.

dxfdouble dimeFaceEntity::getThickness  )  const [virtual]
 

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

Reimplemented in dimeSolid, and dimeTrace.

const dimeVec3f & dimeFaceEntity::getVertex const int  idx  )  const [inline]
 

Returns vertex nr idx.

void dimeFaceEntity::getVertices dimeVec3f v0,
dimeVec3f v1,
dimeVec3f v2,
dimeVec3f v3
const
 

Returns all four vertices.

bool dimeFaceEntity::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 dime3DFace, dimeSolid, and dimeTrace.

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

void dimeFaceEntity::setQuad const dimeVec3f v0,
const dimeVec3f v1,
const dimeVec3f v2,
const dimeVec3f v3
 

Sets vertices to create a quad.

void dimeFaceEntity::setTriangle const dimeVec3f v0,
const dimeVec3f v1,
const dimeVec3f v2
 

Sets vertices to create a triangle.

bool dimeFaceEntity::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 in dimeSolid, and dimeTrace.

int dimeFaceEntity::typeId  )  const [virtual]
 

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

Implements dimeBase.

Reimplemented in dime3DFace, dimeSolid, and dimeTrace.

bool dimeFaceEntity::writeCoords dimeOutput *const  file  )  [protected]
 

Will write the coordinate data to out. Should be called by subclasses at some time during write.


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.