OdGeEntity2d Class Reference

#include <GeEntity2d.h>

Inheritance diagram for OdGeEntity2d:

Public Member Functions
	ODRX_HEAP_OPERATORS ()
	~OdGeEntity2d ()
bool	isKindOf (OdGe::EntityId entType) const
OdGe::EntityId	type () const
OdGeEntity2d *	copy () const
OdGeEntity2d &	operator= (const OdGeEntity2d &entity)
bool	operator== (const OdGeEntity2d &entity) const
bool	operator!= (const OdGeEntity2d &entity) const
bool	isEqualTo (const OdGeEntity2d &other, const OdGeTol &tol=OdGeContext::gTol) const
OdGeEntity2d &	transformBy (const OdGeMatrix2d &xfm)
OdGeEntity2d &	translateBy (const OdGeVector2d &translateVec)
OdGeEntity2d &	rotateBy (double angle, const OdGePoint2d &basePoint=OdGePoint2d::kOrigin)
OdGeEntity2d &	mirror (const OdGeLine2d &line)
OdGeEntity2d &	scaleBy (double scaleFactor, const OdGePoint2d &basePoint=OdGePoint2d::kOrigin)
bool	isOn (const OdGePoint2d &point, const OdGeTol &tol=OdGeContext::gTol) const

Protected Member Functions
	OdGeEntity2d ()
	OdGeEntity2d (const OdGeEntity2d &)
void	connectTo (OdGeEntity2dImpl *)

Friends
class	OdGeEntity2dImpl

Detailed Description

This class is the base class for all OdGe 2D geometric operations.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

Definition at line 43 of file GeEntity2d.h.

Constructor & Destructor Documentation

~OdGeEntity2d()

OdGeEntity2d::~OdGeEntity2d

(

)

Destructor for the OdGeEntity2d class.

OdGeEntity2d() [1/2]

OdGeEntity2d::OdGeEntity2d ( )

protected

OdGeEntity2d() [2/2]

OdGeEntity2d::OdGeEntity2d ( const OdGeEntity2d &  )

protected

Member Function Documentation

connectTo()

void OdGeEntity2d::connectTo ( OdGeEntity2dImpl *  )

protected

copy()

OdGeEntity2d * OdGeEntity2d::copy

(

)

const

Returns a copy of this entity.

Remarks

The returned object is created with the new operator, and it is the responsibility of the caller to delete it.

isEqualTo()

bool OdGeEntity2d::isEqualTo	(	const OdGeEntity2d &	other,
		const OdGeTol &	tol = OdGeContext::gTol
	)		const

Returns true if the specified entity is equal to this one.

Parameters

other	[in] Entity to be compared
tol	[in] Geometric tolerance.

Returns

true if and only if both entities are of the same type, have the same point set within the specified tolerance, and have the same parameterization.

isKindOf()

bool OdGeEntity2d::isKindOf

(

OdGe::EntityId

entType

)

const

Returns true if and only if this entity is of type (or is derived from) entType.

Parameters

entType

[in] Entity type to test.

isOn()

bool OdGeEntity2d::isOn	(	const OdGePoint2d &	point,
		const OdGeTol &	tol = OdGeContext::gTol
	)		const

Returns true if and only if the specified point is on this entity, as determined by the tolerance.

Parameters

point	[in] Point to be queried.
tol	[in] Geometric tolerance.

mirror()

OdGeEntity2d & OdGeEntity2d::mirror

(

const OdGeLine2d &

line

)

Mirrors this entity about the specified 2D line, and returns a reference to this entity.

Parameters

line	[in] Mirror Line.

ODRX_HEAP_OPERATORS()

OdGeEntity2d::ODRX_HEAP_OPERATORS

(

)

operator!=()

bool OdGeEntity2d::operator!=

(

const OdGeEntity2d &

entity

)

const

Comparison operator for the OdGeEntity2d object.

Parameters

entity

[in] Other entity to compare.

Returns

A boolean value that indicates whether the input entity is not identical to this entity.

operator=()

OdGeEntity2d & OdGeEntity2d::operator=

(

const OdGeEntity2d &

entity

)

Assignment operator for the OdGeEntity2d object.

Parameters

entity

[in] Entity to assign.

Returns

A reference to this OdGeEntity2d object.

operator==()

bool OdGeEntity2d::operator==

(

const OdGeEntity2d &

entity

)

const

Comparison operator for the OdGeEntity2d object.

Parameters

entity

[in] Other entity to compare.

Returns

A boolean value that indicates whether the input entity is identical to this entity.

rotateBy()

OdGeEntity2d & OdGeEntity2d::rotateBy	(	double	angle,
		const OdGePoint2d &	basePoint = OdGePoint2d::kOrigin
	)

Rotates this entity about the specified point by the specified angle, and returns a reference to this entity.

Parameters

angle	[in] Rotation angle.
basePoint	[in] Basepoint.

scaleBy()

OdGeEntity2d & OdGeEntity2d::scaleBy	(	double	scaleFactor,
		const OdGePoint2d &	basePoint = OdGePoint2d::kOrigin
	)

Scales this entity by the scale factor about the basepoint, and returns a reference to this entity.

Parameters

scaleFactor	[in] Scale Factor. The scale factor must be greater than zero.
basePoint	[in] Basepoint.

transformBy()

OdGeEntity2d & OdGeEntity2d::transformBy

(

const OdGeMatrix2d &

xfm

)

Applies the 2D transformation matrix to this entity, and returns a reference to this entity.

Parameters

xfm	[in] 2D transformation matrix.

translateBy()

OdGeEntity2d & OdGeEntity2d::translateBy

(

const OdGeVector2d &

translateVec

)

Applies the 2D translation vector to this entity, and returns a reference to this entity.

Parameters

translateVec

[in] Translation Vector.

type()

OdGe::EntityId OdGeEntity2d::type

(

)

const

Returns the entity type of this entity.

Friends And Related Function Documentation

OdGeEntity2dImpl

friend class OdGeEntity2dImpl

friend

Definition at line 191 of file GeEntity2d.h.

---

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

• GeEntity2d.h