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

dimePolyline Class Reference

The dimePolyline class handles a POLYLINE entity. More...

#include <dime/entities/Polyline.h>

Inheritance diagram for dimePolyline:

dimeExtrusionEntity dimeEntity dimeRecordHolder dimeBase List of all members.

Public Types

enum  Type { POLYLINE, POLYFACE_MESH, POLYGON_MESH }
enum  Flags {
  CLOSED = 0x01, POLYMESH_CLOSED_M = 0x01, CURVE_FIT = 0x02, SPLINE_FIT = 0x04,
  IS_POLYLINE_3D = 0x08, IS_POLYMESH_3D = 0x10, POLYMESH_CLOSED_N = 0x20, IS_POLYFACE_MESH = 0x40,
  CONTINOUS_PATTERN = 0x80
}
enum  SurfaceType { NONE = 0, QUADRIC_BSPLINE = 5, CUBIC_BSPLINE = 6, BEZIER = 8 }

Public Member Functions

 dimePolyline ()
virtual ~dimePolyline ()
int16 getFlags () const
void setFlags (const int16 flags)
int getType () const
const dimeVec3fgetElevation () const
void setElevation (const dimeVec3f &e)
int16 getPolymeshCountN () const
int16 getPolymeshCountM () const
int16 getSmoothSurfaceMdensity () const
int16 getSmoothSurfaceNdensity () const
int getNumCoordVertices () const
int getNumIndexVertices () const
int getNumSplineFrameControlPoints () const
int16 getSurfaceType () const
void setSurfaceType (const int16 type)
dimeVertexgetCoordVertex (const int index)
dimeVertexgetIndexVertex (const int index)
dimeVertexgetSplineFrameControlPoint (const int index)
void setCoordVertices (dimeVertex **vertices, const int num, dimeMemHandler *const memhandler=NULL)
void setIndexVertices (dimeVertex **vertices, const int num, dimeMemHandler *const memhandler=NULL)
void setSplineFrameControlPoints (dimeVertex **vertices, const int num, dimeMemHandler *const memhandler=NULL)
virtual dimeEntitycopy (dimeModel *const model) const
virtual bool getRecord (const int groupcode, dimeParam &param, const int index=0) const
virtual void setLayer (const dimeLayer *const layer)
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
virtual GeometryType extractGeometry (dimeArray< dimeVec3f > &verts, dimeArray< int > &indices, dimeVec3f &extrusionDir, dxfdouble &thickness)
void clearSurfaceData ()

Protected Member Functions

virtual bool handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
virtual bool traverse (const dimeState *const state, dimeCallback callback, void *userdata)

Detailed Description

The dimePolyline class handles a POLYLINE entity.


Constructor & Destructor Documentation

dimePolyline::dimePolyline  ) 
 

Constructor.

dimePolyline::~dimePolyline  )  [virtual]
 

Destructor.


Member Function Documentation

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

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

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

const char * dimePolyline::getEntityName  )  const [virtual]
 

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

Implements dimeEntity.

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

int dimePolyline::getType  )  const
 

Convenience function that returns the type of the polyline.

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

bool dimePolyline::read dimeInput *const  file  )  [virtual]
 

Reads a POLYLINE entity.

Reimplemented from dimeEntity.

void dimePolyline::setCoordVertices dimeVertex **  vertices,
const int  num,
dimeMemHandler *const  memhandler = NULL
 

Sets the coordinate vertices for this polyline. Old vertices will be deleted.

void dimePolyline::setIndexVertices dimeVertex **  vertices,
const int  num,
dimeMemHandler *const  memhandler = NULL
 

Sets the index vertices for this polyline. Old vertices will be deleted.

void dimePolyline::setLayer const dimeLayer *const  layer  )  [virtual]
 

Sets the layer for this entity. This will change the record with group code 8. If layer equals NULL, the layer will be set to the default layer.

Reimplemented from dimeEntity.

void dimePolyline::setSplineFrameControlPoints dimeVertex **  vertices,
const int  num,
dimeMemHandler *const  memhandler = NULL
 

Sets the spline frame control point vertices for this polyline. Old control points will be deleted.

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

Overloaded from dimeEntity. Will first do a callback for this entity, then for all vertices. Each vertex will have a pointer to its polyline "parent".

Reimplemented from dimeEntity.

int dimePolyline::typeId  )  const [virtual]
 

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

Reimplemented from dimeExtrusionEntity.

bool dimePolyline::write dimeOutput *const  file  )  [virtual]
 

Writes POLYLINE data to file.

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.