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

dimeSpline Class Reference

The dimeSpline class handles a SPLINE entity. More...

#include <dime/entities/Spline.h>

Inheritance diagram for dimeSpline:

dimeEntity dimeRecordHolder dimeBase List of all members.

Public Types

enum  Flags {
  CLOSED = 0x01, PERIODIC = 0x02, RATIONAL = 0x04, PLANAR = 0x08,
  LINEAR = 0x10
}

Public Member Functions

 dimeSpline ()
virtual ~dimeSpline ()
bool hasWeights () const
int16 getFlags () const
void setFlags (const int16 flags)
int16 getDegree () const
void setDegree (const int16 degree)
dxfdouble getControlPointTolerance () const
void setControlPointTolerance (const dxfdouble tol)
dxfdouble getFitPointTolerance () const
void setFitPointTolerance (const dxfdouble tol)
dxfdouble getKnotTolerance () const
void setKnotTolerance (const dxfdouble tol)
int getNumKnots () const
dxfdouble getKnotValue (const int idx) const
void setKnotValue (const int idx, const dxfdouble value)
void setKnotValues (const dxfdouble *const values, const int numvalues, dimeMemHandler *const memhandler=NULL)
int getNumControlPoints () const
const dimeVec3fgetControlPoint (const int idx) const
void setControlPoint (const int idx, const dimeVec3f &v)
void setControlPoints (const dimeVec3f *const pts, const int numpts, dimeMemHandler *const memhandler=NULL)
int getNumWeights () const
dxfdouble getWeight (const int idx) const
void setWeight (const int idx, const dxfdouble w, dimeMemHandler *const memhandler=NULL)
int getNumFitPoints () const
const dimeVec3fgetFitPoint (const int idx) const
void setFitPoint (const int idx, const dimeVec3f &pt)
void setFitPoints (const dimeVec3f *const pts, const int numpts, dimeMemHandler *const memhandler=NULL)
virtual dimeEntitycopy (dimeModel *const model) const
virtual bool getRecord (const int groupcode, dimeParam &param, const int index) const
virtual const char * getEntityName () const
virtual void print () const
virtual bool write (dimeOutput *const out)
virtual int typeId () const
virtual int countRecords () const

Protected Member Functions

virtual bool handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)

Detailed Description

The dimeSpline class handles a SPLINE entity.


Constructor & Destructor Documentation

dimeSpline::dimeSpline  ) 
 

Constructor.

dimeSpline::~dimeSpline  )  [virtual]
 

Destructor.


Member Function Documentation

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

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

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

Implements dimeEntity.

bool dimeSpline::getRecord const int  groupcode,
dimeParam param,
const int  index
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 dimeSpline::handleRecord const int  groupcode,
const dimeParam param,
dimeMemHandler *const  mh
[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.

bool dimeSpline::hasWeights  )  const
 

Returns true if the spline has control point weights.

void dimeSpline::setControlPoints const dimeVec3f *const  pts,
const int  numpts,
dimeMemHandler *const  memhandler = NULL
 

Sets new control points for this spline. It is the user's responsibility to update the weights whenever the control point are changed.

void dimeSpline::setWeight const int  idx,
const dxfdouble  w,
dimeMemHandler *const  memhandler = NULL
 

Sets the weight of control point idx.

int dimeSpline::typeId  )  const [virtual]
 

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

Implements dimeBase.

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

Will write the records 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.