OdGeClipBoundary2d Class Reference

#include <GeClipBoundary2d.h>

Inheritance diagram for OdGeClipBoundary2d:

Public Member Functions
	GE_OPERATORS_OVERRIDE_2D (OdGeClipBoundary2d)
	OdGeClipBoundary2d ()
	OdGeClipBoundary2d (const OdGePoint2d &cornerA, const OdGePoint2d &cornerB)
	OdGeClipBoundary2d (const OdGePoint2dArray &clipBoundary)
	OdGeClipBoundary2d (const OdGeClipBoundary2d &src)
OdGe::ClipError	set (const OdGePoint2d &cornerA, const OdGePoint2d &cornerB)
OdGe::ClipError	set (const OdGePoint2dArray &clipBoundary)
OdGe::ClipError	clipPolygon (const OdGePoint2dArray &rawVertices, OdGePoint2dArray &clippedVertices, OdGe::ClipCondition &clipCondition, OdGeIntArray *pClippedSegmentSourceLabel=NULL) const
OdGe::ClipError	clipPolyline (const OdGePoint2dArray &rawVertices, OdGePoint2dArray &clippedVertices, OdGe::ClipCondition &clipCondition, OdGeIntArray *pClippedSegmentSourceLabel=NULL) const
OdGeClipBoundary2d &	operator= (const OdGeClipBoundary2d &src)
Public Member Functions inherited from OdGeEntity2d
	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

Additional Inherited Members
Protected Member Functions inherited from OdGeEntity2d
	OdGeEntity2d ()
	OdGeEntity2d (const OdGeEntity2d &)
void	connectTo (OdGeEntity2dImpl *)

Detailed Description

This class defines a planar clipping object for clipping arbitrary 2D polygons or polylines to 2D open or closed polyline curves or rectangles.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

Definition at line 42 of file GeClipBoundary2d.h.

Constructor & Destructor Documentation

OdGeClipBoundary2d() [1/4]

OdGeClipBoundary2d::OdGeClipBoundary2d

(

)

Default constructor for the OdGeClipBoundary2d class. Constructs an empty 2D clip boundary.

OdGeClipBoundary2d() [2/4]

OdGeClipBoundary2d::OdGeClipBoundary2d	(	const OdGePoint2d &	cornerA,
		const OdGePoint2d &	cornerB )

Constructor for the OdGeClipBoundary2d class. Constructs a 2D clip boundary limited by the specified points.

Parameters

cornerA	[in] First corner to define a clip boundary.
cornerB	[in] Second corner to define a clip boundary.

OdGeClipBoundary2d() [3/4]

OdGeClipBoundary2d::OdGeClipBoundary2d

(

const OdGePoint2dArray &

clipBoundary

)

Constructor for the OdGeClipBoundary2d class. Constructs a 2D clip boundary from the passed array of points.

Parameters

clipBoundary

[in] Array of points to define a clip boundary.

OdGeClipBoundary2d() [4/4]

OdGeClipBoundary2d::OdGeClipBoundary2d

(

const OdGeClipBoundary2d &

src

)

Copy constructor for the OdGeClipBoundary2d class. Copies the specified clip boundary.

Parameters

src	[in] Clip boundary to copy.

Member Function Documentation

clipPolygon()

OdGe::ClipError OdGeClipBoundary2d::clipPolygon	(	const OdGePoint2dArray &	rawVertices,
		OdGePoint2dArray &	clippedVertices,
		OdGe::ClipCondition &	clipCondition,
		OdGeIntArray *	pClippedSegmentSourceLabel = NULL ) const

Clips a closed polygon, creating a second closed polygon.

Parameters

rawVertices	[in] Array of 2D points that define the input polygon. Self-intersecting and winding polygons are allowed.
clippedVertices	[out] Receives an array of 2D points that define the clipped resulting closed polygon.
clipCondition	[out] Receives the information about the spatial relationship between the clip boundary and the input clipped polygon.
pClippedSegmentSourceLabel	[in] Optional segment label information identifying the source of each segment in the clipped polygon.

Returns

eOk if clipped successfully, or an appropriate error code otherwise.

clipPolyline()

OdGe::ClipError OdGeClipBoundary2d::clipPolyline	(	const OdGePoint2dArray &	rawVertices,
		OdGePoint2dArray &	clippedVertices,
		OdGe::ClipCondition &	clipCondition,
		OdGeIntArray *	pClippedSegmentSourceLabel = NULL ) const

Clips a polyline, creating a second polyline.

Parameters

rawVertices	[in] Array of 2D points that define the input polyline. Self-intersecting and winding polylines are allowed.
clippedVertices	[out] Receives an array of 2D points that define the clipped resulting polyline.
clipCondition	[out] Receives the information about the spatial relationship between the clip boundary and the input clipped polyline.
pClippedSegmentSourceLabel	[in] Optional segment label information identifying the source of each segment in the clipped polyline.

Returns

eOk if clipped successfully, or an appropriate error code otherwise.

GE_OPERATORS_OVERRIDE_2D()

OdGeClipBoundary2d::GE_OPERATORS_OVERRIDE_2D

(

OdGeClipBoundary2d

)

operator=()

OdGeClipBoundary2d & OdGeClipBoundary2d::operator=

(

const OdGeClipBoundary2d &

src

)

Assignment operator for the OdGeClipBoundary2d class. Assigns properties of the specified clip boundary.

Parameters

src	[in] Clip boundary to assign.

set() [1/2]

OdGe::ClipError OdGeClipBoundary2d::set	(	const OdGePoint2d &	cornerA,
		const OdGePoint2d &	cornerB )

Initializes ortho-aligned rectangular clip boundary.

Parameters

cornerA	[in] First corner to define a clip boundary.
cornerB	[in] Second corner to define a clip boundary.

Returns

eOk if initialized successfully, or an appropriate error code otherwise.

set() [2/2]

OdGe::ClipError OdGeClipBoundary2d::set

(

const OdGePoint2dArray &

clipBoundary

)

Initializes polyline / polygon clip boundary.

Parameters

clipBoundary

[in] Array of points to define a clip boundary.

Returns

eOk if initialized successfully, or an appropriate error code otherwise.

---

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

• GeClipBoundary2d.h