Describes a circle in 3D space.
A circle is defined by its radius and, as with any conic
curve, is positioned in space with a right-handed
coordinate system (gp_Ax2 object) where:
More...

#include <Geom_Circle.hxx>

Inheritance diagram for Geom_Circle:

[legend]

Public Member Functions
	Geom_Circle (const gp_Circ &C)
	Constructs a circle by conversion of the gp_Circ circle C. More...

	Geom_Circle (const gp_Ax2 &A2, const Standard_Real Radius)
	Constructs a circle of radius Radius, where A2 locates the circle and defines its orientation in 3D space such that: More...

void	SetCirc (const gp_Circ &C)
	Set <me> so that <me> has the same geometric properties as C. More...

void	SetRadius (const Standard_Real R)
	Assigns the value R to the radius of this circle. <br> Note: it is possible to have a circle with a radius equal to 0.0. Exceptions - Standard_ConstructionError if R is negative. More...

gp_Circ	Circ () const
	returns the non transient circle from gp with the same geometric properties as <me>. More...

Standard_Real	Radius () const
	Returns the radius of this circle. More...

Standard_Real	ReversedParameter (const Standard_Real U) const
	Computes the parameter on the reversed circle for <br> the point of parameter U on this circle. For a circle, the returned value is: 2.*Pi - U. More...

Standard_Real	Eccentricity () const
	Returns the eccentricity e = 0 for a circle. More...

Standard_Real	FirstParameter () const
	Returns the value of the first parameter of this <br> circle. This is 0.0, which gives the start point of this circle, or The start point and end point of a circle are coincident. More...

Standard_Real	LastParameter () const
	Returns the value of the last parameter of this <br> circle. This is 2.*Pi, which gives the end point of this circle. The start point and end point of a circle are coincident. More...

Standard_Boolean	IsClosed () const
	returns True. More...

Standard_Boolean	IsPeriodic () const
	returns True. More...

void	D0 (const Standard_Real U, gp_Pnt &P) const
	Returns in P the point of parameter U. <br> P = C + R * Cos (U) * XDir + R * Sin (U) * YDir where C is the center of the circle , XDir the XDirection and YDir the YDirection of the circle's local coordinate system. More...

void	D1 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1) const
	Returns the point P of parameter U and the first derivative V1. More...

void	D2 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2) const
	Returns the point P of parameter U, the first and second derivatives V1 and V2. More...

void	D3 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2, gp_Vec &V3) const
	Returns the point P of parameter u, the first second and third derivatives V1 V2 and V3. More...

gp_Vec	DN (const Standard_Real U, const Standard_Integer N) const
	The returned vector gives the value of the derivative for the order of derivation N. //! Raised if N < 1. More...

void	Transform (const gp_Trsf &T)
	Applies the transformation T to this circle. More...

Handle_Geom_Geometry	Copy () const
	Creates a new object which is a copy of this circle. More...

Public Member Functions inherited from Geom_Conic
void	SetAxis (const gp_Ax1 &A1)
	Changes the orientation of the conic's plane. The normal <br> axis to the plane is A1. The XAxis and the YAxis are recomputed. raised if the A1 is parallel to the XAxis of the conic. More...

void	SetLocation (const gp_Pnt &P)
	changes the location point of the conic. More...

void	SetPosition (const gp_Ax2 &A2)
	changes the local coordinate system of the conic. More...

gp_Ax1	Axis () const
	Returns the "main Axis" of this conic. This axis is <br> normal to the plane of the conic. More...

gp_Pnt	Location () const
	Returns the location point of the conic. For the circle, the ellipse and the hyperbola it is the center of the conic. For the parabola it is the Apex of the parabola. More...

const gp_Ax2 &	Position () const
	Returns the local coordinates system of the conic. The main direction of the Axis2Placement is normal to the plane of the conic. The X direction of the Axis2placement is in the plane of the conic and corresponds to the origin for the conic's parametric value u. More...

gp_Ax1	XAxis () const
	Returns the XAxis of the conic. This axis defines the origin of parametrization of the conic. This axis is perpendicular to the Axis of the conic. This axis and the Yaxis define the plane of the conic. More...

gp_Ax1	YAxis () const
	Returns the YAxis of the conic. The YAxis is perpendicular to the Xaxis. This axis and the Xaxis define the plane of the conic. More...

void	Reverse ()
	Reverses the direction of parameterization of <me>. The local coordinate system of the conic is modified. More...

GeomAbs_Shape	Continuity () const
	The continuity of the conic is Cn. More...

Standard_Boolean	IsCN (const Standard_Integer N) const
	Returns True. //! Raised if N < 0. More...

Public Member Functions inherited from Geom_Curve
virtual Standard_Real	TransformedParameter (const Standard_Real U, const gp_Trsf &T) const
	Returns the parameter on the transformed curve for <br> the transform of the point of parameter U on <me>. <br> me->Transformed(T)->Value(me->TransformedParameter(U,T)) is the same point as me->Value(U).Transformed(T) This methods returns <U> It can be redefined. For example on the Line. More...

virtual Standard_Real	ParametricTransformation (const gp_Trsf &T) const
	Returns a coefficient to compute the parameter on <br> the transformed curve for the transform of the <br> point on <me>. <br> Transformed(T)->Value(U * ParametricTransformation(T)) is the same point as Value(U).Transformed(T) This methods returns 1. It can be redefined. For example on the Line. More...

Handle_Geom_Curve	Reversed () const
	Returns a copy of <me> reversed. More...

virtual Standard_Real	Period () const
	Returns the period of this curve. <br> Exceptions Standard_NoSuchObject if this curve is not periodic. More...

gp_Pnt	Value (const Standard_Real U) const
	Computes the point of parameter U on <me>. <br> If the curve is periodic then the returned point is P(U) with U = Ustart + (U - Uend) where Ustart and Uend are the parametric bounds of the curve. it is implemented with D0. Raised only for the "OffsetCurve" if it is not possible to compute the current point. For example when the first derivative on the basis curve and the offset direction are parallel. More...

Public Member Functions inherited from Geom_Geometry
void	Mirror (const gp_Pnt &P)
	Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry. More...

void	Mirror (const gp_Ax1 &A1)
	Performs the symmetrical transformation of a Geometry with respect to an axis placement which is the axis of the symmetry. More...

void	Mirror (const gp_Ax2 &A2)
	Performs the symmetrical transformation of a Geometry with respect to a plane. The axis placement A2 locates the plane of the symmetry : (Location, XDirection, YDirection). More...

void	Rotate (const gp_Ax1 &A1, const Standard_Real Ang)
	Rotates a Geometry. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians. More...

void	Scale (const gp_Pnt &P, const Standard_Real S)
	Scales a Geometry. S is the scaling value. More...

void	Translate (const gp_Vec &V)
	Translates a Geometry. V is the vector of the tanslation. More...

void	Translate (const gp_Pnt &P1, const gp_Pnt &P2)
	Translates a Geometry from the point P1 to the point P2. More...

Handle_Geom_Geometry	Mirrored (const gp_Pnt &P) const

Handle_Geom_Geometry	Mirrored (const gp_Ax1 &A1) const

Handle_Geom_Geometry	Mirrored (const gp_Ax2 &A2) const

Handle_Geom_Geometry	Rotated (const gp_Ax1 &A1, const Standard_Real Ang) const

Handle_Geom_Geometry	Scaled (const gp_Pnt &P, const Standard_Real S) const

Handle_Geom_Geometry	Transformed (const gp_Trsf &T) const

Handle_Geom_Geometry	Translated (const gp_Vec &V) const

Handle_Geom_Geometry	Translated (const gp_Pnt &P1, const gp_Pnt &P2) const

Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const
	Memory deallocator for transient classes. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const Handle_Standard_Type &theType) const
	Returns a true value if this is an instance of Type. More...

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName. More...

Standard_Boolean	IsKind (const Handle_Standard_Type &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

Additional Inherited Members
Protected Attributes inherited from Geom_Conic
gp_Ax2	pos

Detailed Description

Describes a circle in 3D space.
A circle is defined by its radius and, as with any conic
curve, is positioned in space with a right-handed
coordinate system (gp_Ax2 object) where:

the origin is the center of the circle, and
the origin, "X Direction" and "Y Direction" define the
plane of the circle.
This coordinate system is the local coordinate
system of the circle.
The "main Direction" of this coordinate system is the
vector normal to the plane of the circle. The axis, of
which the origin and unit vector are respectively the
origin and "main Direction" of the local coordinate
system, is termed the "Axis" or "main Axis" of the circle.
The "main Direction" of the local coordinate system
gives an explicit orientation to the circle (definition of
the trigonometric sense), determining the direction in
which the parameter increases along the circle.
The Geom_Circle circle is parameterized by an angle:
P(U) = O + R*Cos(U)*XDir + R*Sin(U)*YDir, where:
P is the point of parameter U,
O, XDir and YDir are respectively the origin, "X <br> Direction" and "Y Direction" of its local coordinate system,
R is the radius of the circle.
The "X Axis" of the local coordinate system therefore
defines the origin of the parameter of the circle. The
parameter is the angle with this "X Direction".
A circle is a closed and periodic curve. The period is
2.*Pi and the parameter range is [ 0, 2.*Pi [.

Constructor & Destructor Documentation

Geom_Circle::Geom_Circle ( const gp_Circ & C )

Constructs a circle by conversion of the gp_Circ circle C.

Geom_Circle::Geom_Circle	(	const gp_Ax2 &	A2,
		const Standard_Real	Radius
	)

Constructs a circle of radius Radius, where A2 locates the circle and
defines its orientation in 3D space such that:

the center of the circle is the origin of A2,
the origin, "X Direction" and "Y Direction" of A2
define the plane of the circle,
A2 is the local coordinate system of the circle.
Note: It is possible to create a circle where Radius is equal to 0.0.
//! raised if Radius < 0.

Member Function Documentation

gp_Circ Geom_Circle::Circ ( ) const

returns the non transient circle from gp with the same
geometric properties as <me>.

Handle_Geom_Geometry Geom_Circle::Copy ( ) const

virtual

Creates a new object which is a copy of this circle.

Implements Geom_Geometry.

void Geom_Circle::D0	(	const Standard_Real	U,
		gp_Pnt &	P
	)		const

virtual

Returns in P the point of parameter U. <br>

P = C + R * Cos (U) * XDir + R * Sin (U) * YDir
where C is the center of the circle , XDir the XDirection and
YDir the YDirection of the circle's local coordinate system.

Implements Geom_Curve.

void Geom_Circle::D1	(	const Standard_Real	U,
		gp_Pnt &	P,
		gp_Vec &	V1
	)		const

virtual

Returns the point P of parameter U and the first derivative V1.

Implements Geom_Curve.

void Geom_Circle::D2	(	const Standard_Real	U,
		gp_Pnt &	P,
		gp_Vec &	V1,
		gp_Vec &	V2
	)		const

virtual

Returns the point P of parameter U, the first and second
derivatives V1 and V2.

Implements Geom_Curve.

void Geom_Circle::D3	(	const Standard_Real	U,
		gp_Pnt &	P,
		gp_Vec &	V1,
		gp_Vec &	V2,
		gp_Vec &	V3
	)		const

virtual

Returns the point P of parameter u, the first second and third
derivatives V1 V2 and V3.

Implements Geom_Curve.

gp_Vec Geom_Circle::DN	(	const Standard_Real	U,
		const Standard_Integer	N
	)		const

virtual

The returned vector gives the value of the derivative for the
order of derivation N.
//! Raised if N < 1.

Implements Geom_Curve.

Standard_Real Geom_Circle::Eccentricity ( ) const

virtual

Returns the eccentricity e = 0 for a circle.

Implements Geom_Conic.

Standard_Real Geom_Circle::FirstParameter ( ) const

virtual

 Returns the value of the first parameter of this <br>

circle. This is 0.0, which gives the start point of this circle, or
The start point and end point of a circle are coincident.

Implements Geom_Curve.

Standard_Boolean Geom_Circle::IsClosed ( ) const

virtual

returns True.

Implements Geom_Curve.

Standard_Boolean Geom_Circle::IsPeriodic ( ) const

virtual

returns True.

Implements Geom_Curve.

Standard_Real Geom_Circle::LastParameter ( ) const

virtual

 Returns the value of the last parameter of this <br>

circle. This is 2.*Pi, which gives the end point of this circle.
The start point and end point of a circle are coincident.

Implements Geom_Curve.

Standard_Real Geom_Circle::Radius ( ) const

Returns the radius of this circle.

Standard_Real Geom_Circle::ReversedParameter ( const Standard_Real U ) const

virtual

 Computes the parameter on the reversed circle for <br>

the point of parameter U on this circle.
For a circle, the returned value is: 2.*Pi - U.

Implements Geom_Conic.

void Geom_Circle::SetCirc ( const gp_Circ & C )

Set <me> so that <me> has the same geometric properties as C.

void Geom_Circle::SetRadius ( const Standard_Real R )

 Assigns the value R to the radius of this circle. <br>

Note: it is possible to have a circle with a radius equal to 0.0.
Exceptions - Standard_ConstructionError if R is negative.

void Geom_Circle::Transform ( const gp_Trsf & T )

virtual

Applies the transformation T to this circle.

Implements Geom_Geometry.

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

Geom_Circle.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation