Main Page   Class Hierarchy   Compound List   File List   Compound Members  

dimeEllipse Class Reference

The dimeEllipse class handles an ELLIPSE entity. More...

#include <dime/entities/Ellipse.h>

Inheritance diagram for dimeEllipse::

dimeExtrusionEntity dimeEntity dimeRecordHolder dimeBase List of all members.

Public Methods

 dimeEllipse ()
void setCenter (const dimeVec3f &c)
const dimeVec3fgetCenter () const
void setMajorAxisEndpoint (const dimeVec3f &v)
const dimeVec3fgetMajorAxisEndpoint () const
void setMinorMajorRatio (const dxfdouble ratio)
dxfdouble getMinorMajorRatio () const
void setStartParam (const dxfdouble p)
dxfdouble getStartParam () const
void setEndParam (const dxfdouble p)
dxfdouble getEndParam () 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 void print () const
virtual bool write (dimeOutput *const out)
virtual int typeId () const
virtual int countRecords () const

Protected Methods

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

Detailed Description

The dimeEllipse class handles an ELLIPSE entity.


Constructor & Destructor Documentation

dimeEllipse::dimeEllipse  
 

Constructor.


Member Function Documentation

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

const dimeVec3f & dimeEllipse::getCenter   const [inline]
 

Returns the center coordinates of the ellipse.

dxfdouble dimeEllipse::getEndParam   const [inline]
 

Returns the end parameter for this ellipse.

See also:
dimeEllipse::setEndParam()

const char * dimeEllipse::getEntityName   const [virtual]
 

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

Reimplemented from dimeEntity.

const dimeVec3f & dimeEllipse::getMajorAxisEndpoint   const [inline]
 

Returns the major axis endpoint of this ellipse.

dxfdouble dimeEllipse::getMinorMajorRatio   const [inline]
 

Returns the ratio of the minor axis to the major axis.

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

dxfdouble dimeEllipse::getStartParam   const [inline]
 

Returns the start parameter for this ellipse.

See also:
dimeEllipse::setStartParam()

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

void dimeEllipse::setCenter const dimeVec3f   c [inline]
 

Sets the center coordinates of the ellipse.

void dimeEllipse::setEndParam const dxfdouble    p [inline]
 

Sets the end parameter for this ellipse. Possible values range from 0 to 2pi, but this value should be bigger than the start parameter. Default value is 2pi.

See also:
dimeEllipse::setStartParam()

void dimeEllipse::setMajorAxisEndpoint const dimeVec3f   v [inline]
 

Sets the major axis endpoint of the ellipse.

See also:
dimeEllipse::setRatio()

void dimeEllipse::setMinorMajorRatio const dxfdouble    ratio [inline]
 

Sets the ratio of the minor axis to the major axis.

void dimeEllipse::setStartParam const dxfdouble    p [inline]
 

Sets the start parameter for this ellipse. Possible values range from 0 to 2pi. Default value is 0.

int dimeEllipse::typeId   const [virtual]
 

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

Reimplemented from dimeExtrusionEntity.

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