Contour2D Class

Class Hierarchy

Syntax

C++

class Contour2D;

File

FMContour2D.h

Description

Represents facet body 2D contour objects.

Remarks

Contour2D may contain linear and circular segments.

There are three ways to pick (non-vertex) points on the contour: a) Use an integer index to get a segment and then use a parameter on the segment (GeLine or GeArc). b) Use a distance along the curve from the starting point. c) Use a "parameter" value.

The last way is the fastest (and preferred in most cases) because of the "parameter" structure: dParam = startParam() + iIndex * (dOffsetOnSegment/dSegmentLength)

So the point given by the parameter value can be found fast consistently.

Group

Classes

Public Methods

	Name	Description
	~Contour2D	Destructor.
	Contour2D	This is the overview for the Contour2D constructor overload.

Contour2D Data Members

	Name	Description
	kNull	An empty static contour.

Contour2D Methods

	Name	Description
	addExtents	Appends the extents of the contour to the specified extents structure.
	addVertexAt	Adds a vertex at the specified index.
	appendContour	Appends a contour to the end of this contour.
	appendSegment	Appends a segment to the end of this contour.
	appendVertex	This is the overview for the appendVertex method overload.
	appendVertices	This is the overview for the appendVertices method overload.
	area	Gets the non-negative area of the contour.
	areEqualDists	Checks whether the specified distances are equal depending on the closed state of the contour.
	areEqualParams	Checks whether the specified parameters are equal depending on the closed state of the contour.
	cloneFrom	Clones the contents of the specified contour.
	contains	Checks whether a point is inside the contour, at its boundary, or outside.
	createCircle	Creates Contour2D as full circle with center point and radius specified.
	createSquare	Creates Contour2D as square with center point and side length specified.
	createVertexAt	Adds a vertex to the contour at the specified parameter value.
	createVertexAtDist	Adds a vertex to the contour at the specified distance.
	createVerticesAt	This is the overview for the createVerticesAt method overload.
	deleteCoincident	Removes redundant segments with zero length.
	endParam	Gets the end contour parameter.
	explode	Explodes all arc segments to lines. Sets the uArcMetadata flag on exploded segments.
	explodeTo	Explodes all arc segments to lines. Sets the uArcMetadata flag on exploded segments.
	getArcSegAt	Gets a circular arc segment by the specified index.
	getBulgeAt	Gets a bulge value of a segment with the specified index.
	getDistAtParam	Gets a distance from the start point to the specified parameter.
	getEndPoint	Gets the end point of the contour.
	getGeomExtens	Gets the geometry extents.
	getInternalAngleAt	Gets an internal angle of a vertex with the specified index.
	getLineSegAt	Gets a linear segment by the specified index.
	getNormalizedDist	Converts a distance to the [0, length] range.
	getNormalizedParam	Converts a parameter to the [start param, end param] range.
	getOffsetProfile	Gets the profile that is shifted in the normal direction from this closed contour. E.g., if dOffset is negative, a counter-clockwise circle is extended. If dOffset is positive and small enough, it is contracted, and becomes empty if dOffset > radius.
	getParamAtDist	Gets a parameter at the specified distance from the start point.
	getPoint	Gets a point on the contour at the specified parameter.
	getPointAt	Gets a point by the specified index.
	getPointAtDist	Gets a point on the contour at the specified distance.
	getProfileByOffsets	Gets the profile that is shifted in the normal direction from this closed contour.
	getSegmentAt	This is the overview for the getSegmentAt method overload.
	getStartPoint	Gets the start point of the contour.
	getSubContour	Gets a sub-contour given by two parameters.
	getTangent	Gets a tangent to the contour at the specified parameter.
	getTangentAtDist	Gets a tangent at the distance along the contour starting from the start point.
	getVertexAt	Gets data of a vertex with the specified index.
	hasArcs	Checks whether the contour has arcs.
	implClass	Gets the implementation type.
	intersect	This is the overview for the intersect method overload.
	intersectLine	Calculates all intersections with the specified line and appends the result to vecPoints.
	isCCW	Gets the orientation of the contour.
	isClosed	Checks whether the contour is closed.
	isConvex	Checks whether the contour is convex.
	isEmpty	Checks whether the contour is empty.
	isEndsEqual	Checks whether the start and the end of the contour are equal to the specified tolerance.
	isExplodedArcAt	Gets the ecfExplodedArc flag value at the specified segment.
	isHiddenAt	Checks whether the segment with the specified index is hidden.
	isInsideContour	Checks whether this contour is inside the specified contour.
	isOn	Checks whether the 2D point is located on the contour with the given tolerance. If the point is on the contour, the method calculates the parameter value at this point.
	isSelfIntersecting	Checks whether the contour intersects itself.
	isValidRegion	Checks whether this contour is closed and coincides with a directional boundary of an open 2D region.
	length	Gets the length of the contour.
	makeCCW	Makes the contour counter-clockwise or clockwise.
	mergeSegments	Merges adjacent segments.
	metadataAt	Gets metadata for the specified segment.
	nearestParam	Gets the nearest parameter and (optional) point on the contour for the given 2D point.
	numSegments	Gets the number of segments.
	numVerts	Gets the number of vertices.
	orientationAt	Gets the orientation of the segment with the specified index.
	rawFlagsAt	Returns all built-in flags (orientation, visibility etc.) for the specified segment.
	removeVertexAt	Removes a vertex and corresponding segment.
	reserveVertices	Sets the capacity of the contour data to the specified vertex number.
	reset	Clears the contents of the contour.
	reverse	Reverses the contour.
	segmentType	Gets the type of segment that begins at the specified vertex.
	setAllMetadata	Sets metadata for all segments.
	setBulgeAt	Sets a bulge value for a vertex with the specified index.
	setClosed	Makes the contour closed (or open).
	setExplodedArcAt	Sets or clears the ecfExplodedArc flag at the specified segment.
	setHiddenAt	Sets or clears the ecfHidden flag at the specified segment.
	setMetadataAt	Sets metadata for the specified segment.
	setOrientationAt	Sets the orientation of the segment with the specified index.
	setPointAt	Sets a position of a vertex with the specified index.
	setRawFlagsAt	Updates all built-in flags (orientation, visibility etc.) for the specified segment.
	setThreatAsSmoothCurveAt	Sets the "smooth" flag value.
	setVertexAt	Sets a location and a bulge value for a vertex with the specified index.
	signedArea	Gets the signed area of the contour.
	startParam	Gets the start contour parameter.
	swap	Swaps the contents of the contour with another one.
	threatAsSmoothCurveAt	Gets the "smooth" flag value of the segment with the specified index.
	transformBy	Transforms the contour.
	traverse	Traverses the contour.

Contour2D Operators

	Name	Description
	=	This is the overview for the = operator overload.

Send feedback about this topic