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

#include <dime/entities/Ellipse.h>

Inheritance diagram for dimeEllipse:

Public Member Functions
	dimeEllipse ()

void	setCenter (const dimeVec3f &c)

const dimeVec3f &	getCenter () const

void	setMajorAxisEndpoint (const dimeVec3f &v)

const dimeVec3f &	getMajorAxisEndpoint () 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 dimeEntity *	copy (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

Public Member Functions inherited from dimeExtrusionEntity
	dimeExtrusionEntity ()

void	setExtrusionDir (const dimeVec3f &v)

const dimeVec3f &	getExtrusionDir () const

void	setThickness (const dxfdouble val)

dxfdouble	getThickness () const

virtual bool	isOfType (const int thtypeid) const

Public Member Functions inherited from dimeEntity
	dimeEntity ()

virtual	~dimeEntity ()

int16	getEntityFlags () const

void	setEntityFlags (const int16 flags)

int16	getColorNumber () const

void	setColorNumber (const int16 c)

virtual void	setLayer (const dimeLayer *const layer)

const dimeLayer *	getLayer () const

const char *	getLayerName () const

virtual bool	read (dimeInput *const in)

bool	isDeleted () const

void	setDeleted (const bool onOff=true)

bool	isTagged () const

void	setTagged (const bool onOff=true)

virtual GeometryType	extractGeometry (dimeArray< dimeVec3f > &verts, dimeArray< int > &indices, dimeVec3f &extrusionDir, dxfdouble &thickness)

Public Member Functions inherited from dimeRecordHolder
	dimeRecordHolder (const int separator)

virtual	~dimeRecordHolder ()

void	setRecord (const int groupcode, const dimeParam &value, dimeMemHandler *const memhandler=NULL)

void	setRecords (const int const groupcodes, const dimeParam const params, const int numrecords, dimeMemHandler *const memhandler=NULL)

void	setIndexedRecord (const int groupcode, const dimeParam &value, const int index, dimeMemHandler *const memhandler=NULL)

dimeRecord *	findRecord (const int groupcode, const int index=0)

int	getNumRecordsInRecordHolder (void) const

dimeRecord *	getRecordInRecordHolder (const int idx) const

Public Member Functions inherited from dimeBase
	dimeBase (void)

virtual	~dimeBase ()

void *	operator new (size_t size, dimeMemHandler *memhandler=NULL, const int alignment=4)

void	operator delete (void *ptr)

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

Protected Member Functions inherited from dimeExtrusionEntity
void	copyExtrusionData (const dimeExtrusionEntity *const entity)

bool	writeExtrusionData (dimeOutput *const out)

Protected Member Functions inherited from dimeEntity
bool	preWrite (dimeOutput *const file)

virtual bool	traverse (const dimeState const state, dimeCallback callback, void userdata)

virtual void	fixReferences (dimeModel *const model)

virtual bool	shouldWriteRecord (const int groupcode) const

bool	copyRecords (dimeEntity const entity, dimeModel const model) const

Protected Member Functions inherited from dimeRecordHolder
bool	copyRecords (dimeRecordHolder const rh, dimeMemHandler const memhandler) const

Additional Inherited Members
Public Types inherited from dimeEntity
enum	GeometryType { NONE, POLYGONS, LINES, POINTS }

Public Types inherited from dimeBase
enum	{ dimeBaseType = 1, dimeRecordType, dimeStringRecordType, dimeFloatRecordType, dimeDoubleRecordType, dimeInt8RecordType, dimeInt16RecordType, dimeInt32RecordType, dimeHexRecordType, dimeRecordHolderType, dimeClassType, dimeUnknownClassType, dimeObjectType, dimeUnknownObjectType, dimeEntityType, dimeUnknownEntityType, dimePolylineType, dimeVertexType, dimeFaceEntityType, dimeExtrusionEntityType, dime3DFaceType, dimeSolidType, dimeTraceType, dimeLineType, dimeTextType, dimePointType, dimeBlockType, dimeInsertType, dimeCircleType, dimeArcType, dimeLWPolylineType, dimeEllipseType, dimeSplineType, dimeSectionType, dimeUnknownSectionType, dimeEntitiesSectionType, dimeBlocksSectionType, dimeTablesSectionType, dimeHeaderSectionType, dimeClassesSectionType, dimeObjectsSectionType, dimeTableType, dimeTableEntryType, dimeUnknownTableType, dimeUCSTableType, dimeLayerTableType, dimeLastTypeTag }

Static Public Member Functions inherited from dimeEntity
static dimeEntity *	createEntity (const char const name, dimeMemHandler const memhandler=NULL)

static bool	readEntities (dimeInput const file, dimeArray< dimeEntity > &array, const char *const stopat)

static bool	copyEntityArray (const dimeEntity const const array, const int nument, dimeModel const model, dimeArray< dimeEntity > &destarray)

static dimeEntity **	copyEntityArray (const dimeEntity const const array, int &nument, dimeModel *const model)

static void	arbitraryAxis (const dimeVec3f &givenaxis, dimeVec3f &newaxis)

static void	generateUCS (const dimeVec3f &givenaxis, dimeMatrix &m)

Protected Attributes inherited from dimeExtrusionEntity
dimeVec3f	extrusionDir

dxfdouble	thickness

Protected Attributes inherited from dimeRecordHolder
dimeRecord **	records

int	numRecords

Detailed Description

The dimeEllipse class handles an ELLIPSE entity.

Constructor & Destructor Documentation

◆ dimeEllipse()

dimeEllipse::dimeEllipse ( )

Constructor.

Member Function Documentation

◆ setCenter()

void dimeEllipse::setCenter ( const dimeVec3f & c )

inline

Sets the center coordinates of the ellipse.

◆ getCenter()

const dimeVec3f & dimeEllipse::getCenter ( ) const

inline

Returns the center coordinates of the ellipse.

◆ setMajorAxisEndpoint()

void dimeEllipse::setMajorAxisEndpoint ( const dimeVec3f & v )

inline

Sets the major axis endpoint of the ellipse.

See also: dimeEllipse::setRatio()

◆ getMajorAxisEndpoint()

const dimeVec3f & dimeEllipse::getMajorAxisEndpoint ( ) const

inline

Returns the major axis endpoint of this ellipse.

◆ setMinorMajorRatio()

void dimeEllipse::setMinorMajorRatio ( const dxfdouble ratio )

inline

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

◆ getMinorMajorRatio()

dxfdouble dimeEllipse::getMinorMajorRatio ( ) const

inline

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

◆ setStartParam()

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.

◆ getStartParam()

dxfdouble dimeEllipse::getStartParam ( ) const

inline

Returns the start parameter for this ellipse.

See also: dimeEllipse::setStartParam()

◆ setEndParam()

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()

◆ getEndParam()

dxfdouble dimeEllipse::getEndParam ( ) const

inline

Returns the end parameter for this ellipse.

See also: dimeEllipse::setEndParam()

◆ copy()

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.

Implements dimeEntity.

◆ getRecord()

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.

◆ getEntityName()

const char * dimeEllipse::getEntityName ( ) const

virtual

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

Implements dimeEntity.

◆ write()

bool dimeEllipse::write ( dimeOutput *const file )

virtual

Will write the records to file.

Reimplemented from dimeEntity.

◆ typeId()

int dimeEllipse::typeId ( ) const

virtual

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

Reimplemented from dimeExtrusionEntity.

◆ countRecords()

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.

◆ handleRecord()

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

protectedvirtual

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.

The documentation for this class was generated from the following files:

Ellipse.h
Ellipse.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ dimeEllipse()

Member Function Documentation

◆ setCenter()

◆ getCenter()

◆ setMajorAxisEndpoint()

◆ getMajorAxisEndpoint()

◆ setMinorMajorRatio()

◆ getMinorMajorRatio()

◆ setStartParam()

◆ getStartParam()

◆ setEndParam()

◆ getEndParam()

◆ copy()

◆ getRecord()

◆ getEntityName()

◆ write()

◆ typeId()

◆ countRecords()

◆ handleRecord()