Describes a plane in 3D space. A plane is positioned in space by a coordinate system (a gp_Ax3 object) such that the plane is defined by the origin, "X Direction" and "Y Direction" of this coordinate system. This coordinate system is the "local coordinate system" of the plane. The following apply: More...

#include <Geom_Plane.hxx>

Inheritance diagram for Geom_Plane:

[legend]

Public Member Functions
	Geom_Plane (const gp_Ax3 &A3)
	Creates a plane located in 3D space with an axis placement three axis. The "ZDirection" of "A3" is the direction normal to the plane. The "Location" point of "A3" is the origin of the plane. The "XDirection" and "YDirection" of "A3" define the directions of the U isoparametric and V isoparametric curves.

	Geom_Plane (const gp_Pln &Pl)
	Creates a plane from a non transient plane from package gp.

	Geom_Plane (const gp_Pnt &P, const gp_Dir &V)
	P is the "Location" point or origin of the plane. V is the direction normal to the plane.

	Geom_Plane (const double A, const double B, const double C, const double D)
	Creates a plane from its cartesian equation:

void	SetPln (const gp_Pln &Pl)
	Set <me> so that <me> has the same geometric properties as Pl.

gp_Pln	Pln () const
	Converts this plane into a gp_Pln plane.

void	UReverse () final
	Changes the orientation of this plane in the u (or v) parametric direction. The bounds of the plane are not changed but the given parametric direction is reversed. Hence the orientation of the surface is reversed.

double	UReversedParameter (const double U) const final
	Computes the u parameter on the modified plane, produced when reversing the u parametric of this plane, for any point of u parameter U on this plane. In the case of a plane, these methods return - -U.

void	VReverse () final
	Changes the orientation of this plane in the u (or v) parametric direction. The bounds of the plane are not changed but the given parametric direction is reversed. Hence the orientation of the surface is reversed.

double	VReversedParameter (const double V) const final
	Computes the v parameter on the modified plane, produced when reversing the v parametric of this plane, for any point of v parameter V on this plane. In the case of a plane, these methods return -V.

void	TransformParameters (double &U, double &V, const gp_Trsf &T) const final
	Computes the parameters on the transformed surface for the transform of the point of parameters U,V on <me>.

gp_GTrsf2d	ParametricTransformation (const gp_Trsf &T) const final
	Returns a 2d transformation used to find the new parameters of a point on the transformed surface.

void	Bounds (double &U1, double &U2, double &V1, double &V2) const final
	Returns the parametric bounds U1, U2, V1 and V2 of this plane. Because a plane is an infinite surface, the following is always true:

void	Coefficients (double &A, double &B, double &C, double &D) const
	Computes the normalized coefficients of the plane's cartesian equation:

bool	IsUClosed () const final
	return False

bool	IsVClosed () const final
	return False

bool	IsUPeriodic () const final
	return False.

bool	IsVPeriodic () const final
	return False.

occ::handle< Geom_Curve >	UIso (const double U) const final
	Computes the U isoparametric curve. This is a Line parallel to the YAxis of the plane.

occ::handle< Geom_Curve >	VIso (const double V) const final
	Computes the V isoparametric curve. This is a Line parallel to the XAxis of the plane.

gp_Pnt	EvalD0 (const double U, const double V) const final
	Computes the point P (U, V) on <me>.

Geom_Surface::ResD1	EvalD1 (const double U, const double V) const final
	Computes the current point and the first derivatives in the directions U and V.

Geom_Surface::ResD2	EvalD2 (const double U, const double V) const final
	Computes the current point, the first and the second derivatives in the directions U and V.

Geom_Surface::ResD3	EvalD3 (const double U, const double V) const final
	Computes the current point, the first,the second and the third derivatives in the directions U and V.

gp_Vec	EvalDN (const double U, const double V, const int Nu, const int Nv) const final
	Computes the derivative of order Nu in the direction u and Nv in the direction v. Raised if Nu + Nv < 1 or Nu < 0 or Nv < 0.

void	Transform (const gp_Trsf &T) final
	Applies the transformation T to this plane.

occ::handle< Geom_Geometry >	Copy () const final
	Creates a new object which is a copy of this plane.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const final
	Dumps the content of me into the stream.

Public Member Functions inherited from Geom_ElementarySurface
void	SetAxis (const gp_Ax1 &theA1)
	Changes the main axis (ZAxis) of the elementary surface.

void	SetLocation (const gp_Pnt &theLoc)
	Changes the location of the local coordinates system of the surface.

void	SetPosition (const gp_Ax3 &theAx3)
	Changes the local coordinates system of the surface.

const gp_Ax1 &	Axis () const
	Returns the main axis of the surface (ZAxis).

const gp_Pnt &	Location () const
	Returns the location point of the local coordinate system of the surface.

const gp_Ax3 &	Position () const
	Returns the local coordinates system of the surface.

GeomAbs_Shape	Continuity () const override
	Returns GeomAbs_CN, the global continuity of any elementary surface.

bool	IsCNu (const int N) const override
	Returns True.

bool	IsCNv (const int N) const override
	Returns True.

Public Member Functions inherited from Geom_Surface
occ::handle< Geom_Surface >	UReversed () const
	Reverses the U direction of parametrization of <me>. The bounds of the surface are not modified. A copy of <me> is returned.

occ::handle< Geom_Surface >	VReversed () const
	Reverses the V direction of parametrization of <me>. The bounds of the surface are not modified. A copy of <me> is returned.

virtual double	UPeriod () const
	Returns the period of this surface in the u parametric direction. Raises if the surface is not uperiodic.

virtual double	VPeriod () const
	Returns the period of this surface in the v parametric direction. raises if the surface is not vperiodic.

void	D0 (const double U, const double V, gp_Pnt &P) const
	Computes the point of parameter (U, V).

void	D1 (const double U, const double V, gp_Pnt &P, gp_Vec &D1U, gp_Vec &D1V) const
	Computes the point and first partial derivatives.

void	D2 (const double U, const double V, gp_Pnt &P, gp_Vec &D1U, gp_Vec &D1V, gp_Vec &D2U, gp_Vec &D2V, gp_Vec &D2UV) const
	Computes the point and partial derivatives up to 2nd order.

void	D3 (const double U, const double V, gp_Pnt &P, gp_Vec &D1U, gp_Vec &D1V, gp_Vec &D2U, gp_Vec &D2V, gp_Vec &D2UV, gp_Vec &D3U, gp_Vec &D3V, gp_Vec &D3UUV, gp_Vec &D3UVV) const
	Computes the point and partial derivatives up to 3rd order.

gp_Vec	DN (const double U, const double V, const int Nu, const int Nv) const
	Computes the derivative of order Nu in U and Nv in V.

gp_Pnt	Value (const double U, const double V) const
	Computes the point of parameter (U, V) on the surface.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.

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.

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.

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

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

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

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

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

occ::handle< Geom_Geometry >	Mirrored (const gp_Pnt &P) const

occ::handle< Geom_Geometry >	Mirrored (const gp_Ax1 &A1) const

occ::handle< Geom_Geometry >	Mirrored (const gp_Ax2 &A2) const

occ::handle< Geom_Geometry >	Rotated (const gp_Ax1 &A1, const double Ang) const

occ::handle< Geom_Geometry >	Scaled (const gp_Pnt &P, const double S) const

occ::handle< Geom_Geometry >	Transformed (const gp_Trsf &T) const

occ::handle< Geom_Geometry >	Translated (const gp_Vec &V) const

occ::handle< Geom_Geometry >	Translated (const gp_Pnt &P1, const gp_Pnt &P2) const

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

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

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

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::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.

bool	IsKind (const char *const 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.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Attributes inherited from Geom_ElementarySurface
gp_Ax3	pos

Detailed Description

Describes a plane in 3D space. A plane is positioned in space by a coordinate system (a gp_Ax3 object) such that the plane is defined by the origin, "X Direction" and "Y Direction" of this coordinate system. This coordinate system is the "local coordinate system" of the plane. The following apply:

Its "X Direction" and "Y Direction" are respectively the u and v parametric directions of the plane.
Its origin is the origin of the u and v parameters (also called the "origin" of the plane).
Its "main Direction" is a vector normal to the plane. This normal vector gives the orientation of the plane only if the local coordinate system is "direct". (The orientation of the plane is always defined by the "X Direction" and the "Y Direction" of its local coordinate system.) The parametric equation of the plane is:
P(u, v) = O + u*XDir + v*YDir

NCollection_ForwardRangeIterator
STL input iterator that wraps an OCCT More()/Next() iterator.
Definition NCollection_ForwardRange.hxx:142

where O, XDir and YDir are respectively the origin, the "X Direction" and the "Y Direction" of the local coordinate system of the plane. The parametric range of the two parameters u and v is ] -infinity, +infinity [.

Constructor & Destructor Documentation

◆ Geom_Plane() [1/4]

Geom_Plane::Geom_Plane ( const gp_Ax3 & A3 )

Creates a plane located in 3D space with an axis placement three axis. The "ZDirection" of "A3" is the direction normal to the plane. The "Location" point of "A3" is the origin of the plane. The "XDirection" and "YDirection" of "A3" define the directions of the U isoparametric and V isoparametric curves.

◆ Geom_Plane() [2/4]

Geom_Plane::Geom_Plane ( const gp_Pln & Pl )

Creates a plane from a non transient plane from package gp.

◆ Geom_Plane() [3/4]

Geom_Plane::Geom_Plane	(	const gp_Pnt &	P,
		const gp_Dir &	V )

P is the "Location" point or origin of the plane. V is the direction normal to the plane.

◆ Geom_Plane() [4/4]

Geom_Plane::Geom_Plane	(	const double	A,
		const double	B,
		const double	C,
		const double	D )

Creates a plane from its cartesian equation:

Ax + By + Cz + D = 0.0

Raised if std::sqrt(A*A + B*B + C*C) <= Resolution from gp

Member Function Documentation

◆ Bounds()

void Geom_Plane::Bounds	(	double &	U1,
		double &	U2,
		double &	V1,
		double &	V2 ) const

finalvirtual

Returns the parametric bounds U1, U2, V1 and V2 of this plane. Because a plane is an infinite surface, the following is always true:

U1 = V1 = double::RealFirst()
U2 = V2 = double::RealLast().

Implements Geom_Surface.

◆ Coefficients()

void Geom_Plane::Coefficients	(	double &	A,
		double &	B,
		double &	C,
		double &	D ) const

Computes the normalized coefficients of the plane's cartesian equation:

Ax + By + Cz + D = 0.0

◆ Copy()

occ::handle< Geom_Geometry > Geom_Plane::Copy ( ) const

finalvirtual

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

Implements Geom_Geometry.

◆ DumpJson()

void Geom_Plane::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

finalvirtual

Dumps the content of me into the stream.

Reimplemented from Geom_ElementarySurface.

◆ EvalD0()

gp_Pnt Geom_Plane::EvalD0	(	const double	U,
		const double	V ) const

finalvirtual

Computes the point P (U, V) on <me>.

P = O + U * XDir + V * YDir.

where O is the "Location" point of the plane, XDir the "XDirection" and YDir the "YDirection" of the plane's local coordinate system.

Implements Geom_Surface.

◆ EvalD1()

Geom_Surface::ResD1 Geom_Plane::EvalD1	(	const double	U,
		const double	V ) const

finalvirtual

Computes the current point and the first derivatives in the directions U and V.

Implements Geom_Surface.

◆ EvalD2()

Geom_Surface::ResD2 Geom_Plane::EvalD2	(	const double	U,
		const double	V ) const

finalvirtual

Computes the current point, the first and the second derivatives in the directions U and V.

Implements Geom_Surface.

◆ EvalD3()

Geom_Surface::ResD3 Geom_Plane::EvalD3	(	const double	U,
		const double	V ) const

finalvirtual

Computes the current point, the first,the second and the third derivatives in the directions U and V.

Implements Geom_Surface.

◆ EvalDN()

gp_Vec Geom_Plane::EvalDN	(	const double	U,
		const double	V,
		const int	Nu,
		const int	Nv ) const

finalvirtual

Computes the derivative of order Nu in the direction u and Nv in the direction v. Raised if Nu + Nv < 1 or Nu < 0 or Nv < 0.

Implements Geom_Surface.

◆ IsUClosed()

bool Geom_Plane::IsUClosed ( ) const

finalvirtual

return False

Implements Geom_Surface.

◆ IsUPeriodic()

bool Geom_Plane::IsUPeriodic ( ) const

finalvirtual

return False.

Implements Geom_Surface.

◆ IsVClosed()

bool Geom_Plane::IsVClosed ( ) const

finalvirtual

return False

Implements Geom_Surface.

◆ IsVPeriodic()

bool Geom_Plane::IsVPeriodic ( ) const

finalvirtual

return False.

Implements Geom_Surface.

◆ ParametricTransformation()

gp_GTrsf2d Geom_Plane::ParametricTransformation ( const gp_Trsf & T ) const

finalvirtual

Returns a 2d transformation used to find the new parameters of a point on the transformed surface.

me->Transformed(T)->Value(U',V')

is the same point as

me->Value(U,V).Transformed(T)

Where U',V' are obtained by transforming U,V with the 2d transformation returned by

me->ParametricTransformation(T)

This method returns a scale centered on the origin with T.ScaleFactor

Reimplemented from Geom_Surface.

◆ Pln()

gp_Pln Geom_Plane::Pln ( ) const

Converts this plane into a gp_Pln plane.

◆ SetPln()

void Geom_Plane::SetPln ( const gp_Pln & Pl )

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

◆ Transform()

void Geom_Plane::Transform ( const gp_Trsf & T )

finalvirtual

Applies the transformation T to this plane.

Implements Geom_Geometry.

◆ TransformParameters()

void Geom_Plane::TransformParameters	(	double &	U,
		double &	V,
		const gp_Trsf &	T ) const

finalvirtual

Computes the parameters on the transformed surface for the transform of the point of parameters U,V on <me>.

me->Transformed(T)->Value(U',V')

is the same point as

me->Value(U,V).Transformed(T)

Where U',V' are the new values of U,V after calling

me->TransformParameters(U,V,T)

This method multiplies U and V by T.ScaleFactor()

Reimplemented from Geom_Surface.

◆ UIso()

occ::handle< Geom_Curve > Geom_Plane::UIso ( const double U ) const

finalvirtual

Computes the U isoparametric curve. This is a Line parallel to the YAxis of the plane.

Implements Geom_Surface.

◆ UReverse()

void Geom_Plane::UReverse ( )

finalvirtual

Changes the orientation of this plane in the u (or v) parametric direction. The bounds of the plane are not changed but the given parametric direction is reversed. Hence the orientation of the surface is reversed.

Reimplemented from Geom_ElementarySurface.

◆ UReversedParameter()

double Geom_Plane::UReversedParameter ( const double U ) const

finalvirtual

Computes the u parameter on the modified plane, produced when reversing the u parametric of this plane, for any point of u parameter U on this plane. In the case of a plane, these methods return - -U.

Implements Geom_ElementarySurface.

◆ VIso()

occ::handle< Geom_Curve > Geom_Plane::VIso ( const double V ) const

finalvirtual

Computes the V isoparametric curve. This is a Line parallel to the XAxis of the plane.

Implements Geom_Surface.

◆ VReverse()

void Geom_Plane::VReverse ( )

finalvirtual

Changes the orientation of this plane in the u (or v) parametric direction. The bounds of the plane are not changed but the given parametric direction is reversed. Hence the orientation of the surface is reversed.

Reimplemented from Geom_ElementarySurface.

◆ VReversedParameter()

double Geom_Plane::VReversedParameter ( const double V ) const

finalvirtual

Computes the v parameter on the modified plane, produced when reversing the v parametric of this plane, for any point of v parameter V on this plane. In the case of a plane, these methods return -V.

Implements Geom_ElementarySurface.

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

Geom_Plane.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geom_Plane() [1/4]

◆ Geom_Plane() [2/4]

◆ Geom_Plane() [3/4]

◆ Geom_Plane() [4/4]

Member Function Documentation

◆ Bounds()

◆ Coefficients()

◆ Copy()

◆ DumpJson()

◆ EvalD0()

◆ EvalD1()

◆ EvalD2()

◆ EvalD3()

◆ EvalDN()

◆ IsUClosed()

◆ IsUPeriodic()

◆ IsVClosed()

◆ IsVPeriodic()

◆ ParametricTransformation()

◆ Pln()

◆ SetPln()

◆ Transform()

◆ TransformParameters()

◆ UIso()

◆ UReverse()

◆ UReversedParameter()

◆ VIso()

◆ VReverse()

◆ VReversedParameter()