Geom_Axis1Placement Class Reference

Describes an axis in 3D space. An axis is defined by: More...

#include <Geom_Axis1Placement.hxx>

Inheritance diagram for Geom_Axis1Placement:

Public Member Functions
	Geom_Axis1Placement (const gp_Ax1 &A1)
	Returns a transient copy of A1.
	Geom_Axis1Placement (const gp_Pnt &P, const gp_Dir &V)
	P is the origin of the axis placement and V is the direction of the axis placement.
const gp_Ax1 &	Ax1 () const
	Returns a non transient copy of <me>.
void	Reverse ()
	Reverses the direction of the axis placement.
occ::handle< Geom_Axis1Placement >	Reversed () const
	Returns a copy of <me> reversed.
void	SetDirection (const gp_Dir &V) override
	Assigns V to the unit vector of this axis.
void	Transform (const gp_Trsf &T) override
	Applies the transformation T to this axis.
occ::handle< Geom_Geometry >	Copy () const override
	Creates a new object, which is a copy of this axis.
Public Member Functions inherited from Geom_AxisPlacement
void	SetAxis (const gp_Ax1 &A1)
	Assigns A1 as the "main Axis" of this positioning system. This modifies.
void	SetLocation (const gp_Pnt &P)
	Assigns the point P as the origin of this positioning system.
double	Angle (const occ::handle< Geom_AxisPlacement > &Other) const
	Computes the angular value, in radians, between the "main Direction" of this positioning system and that of positioning system Other. The result is a value between 0 and Pi.
const gp_Ax1 &	Axis () const
	Returns the main axis of the axis placement. For an "Axis2placement" it is the main axis (Location, Direction ). For an "Axis1Placement" this method returns a copy of <me>.
gp_Dir	Direction () const
	Returns the main "Direction" of an axis placement.
gp_Pnt	Location () const
	Returns the Location point (origin) of the axis placement.
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
virtual void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.
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
typedef void	base_type
	Returns a type descriptor about this object.
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_AxisPlacement
gp_Ax1	axis

Detailed Description

Describes an axis in 3D space. An axis is defined by:

• its origin, also termed the "Location point" of the axis,
• its unit vector, termed the "Direction" of the axis. Note: Geom_Axis1Placement axes provide the same kind of "geometric" services as gp_Ax1 axes but have more complex data structures. The geometric objects provided by the Geom package use gp_Ax1 objects to include axes in their data structures, or to define an axis of symmetry or axis of rotation. Geom_Axis1Placement axes are used in a context where they can be shared by several objects contained inside a common data structure.

Constructor & Destructor Documentation

Geom_Axis1Placement() [1/2]

Geom_Axis1Placement::Geom_Axis1Placement

(

const gp_Ax1 &

A1

)

Returns a transient copy of A1.

Geom_Axis1Placement() [2/2]

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

P is the origin of the axis placement and V is the direction of the axis placement.

Member Function Documentation

Ax1()

const gp_Ax1 & Geom_Axis1Placement::Ax1

(

)

const

Returns a non transient copy of <me>.

Copy()

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

overridevirtual

Creates a new object, which is a copy of this axis.

Implements Geom_Geometry.

Reverse()

void Geom_Axis1Placement::Reverse

(

)

Reverses the direction of the axis placement.

Reversed()

occ::handle< Geom_Axis1Placement > Geom_Axis1Placement::Reversed ( ) const

nodiscard

Returns a copy of <me> reversed.

SetDirection()

void Geom_Axis1Placement::SetDirection ( const gp_Dir & V )

overridevirtual

Assigns V to the unit vector of this axis.

Implements Geom_AxisPlacement.

Transform()

void Geom_Axis1Placement::Transform ( const gp_Trsf & T )

overridevirtual

Applies the transformation T to this axis.

Implements Geom_Geometry.

---

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

• Geom_Axis1Placement.hxx