OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Geom2d_AxisPlacement Class Reference

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

    #include <Geom2d_AxisPlacement.hxx>

    Inheritance diagram for Geom2d_AxisPlacement:

    Public Member Functions

     Geom2d_AxisPlacement (const gp_Ax2d &A)
     Constructs an axis by conversion of the gp_Ax2d axis A.
     Geom2d_AxisPlacement (const gp_Pnt2d &P, const gp_Dir2d &V)
     Constructs an axis from a given origin P and unit vector V.
    void Reverse ()
    occ::handle< Geom2d_AxisPlacementReversed () const
     Reverses the unit vector of this axis. Note:
    void SetAxis (const gp_Ax2d &A)
     Changes the complete definition of the axis placement.
    void SetDirection (const gp_Dir2d &V)
     Changes the "Direction" of the axis placement.
    void SetLocation (const gp_Pnt2d &P)
     Changes the "Location" point (origin) of the axis placement.
    double Angle (const occ::handle< Geom2d_AxisPlacement > &Other) const
     Computes the angle between the "Direction" of two axis placement in radians. The result is comprised between -Pi and Pi.
    gp_Ax2d Ax2d () const
     Converts this axis into a gp_Ax2d axis.
    gp_Dir2d Direction () const
     Returns the "Direction" of <me>. -C++: return const&.
    gp_Pnt2d Location () const
     Returns the "Location" point (origin) of the axis placement. -C++: return const&.
    void Transform (const gp_Trsf2d &T) override
     Applies the transformation T to this axis.
    occ::handle< Geom2d_GeometryCopy () const override
     Creates a new object which is a copy of this axis.
    Public Member Functions inherited from Geom2d_Geometry
    void Mirror (const gp_Pnt2d &P)
     Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry and assigns the result to this geometric object.
    void Mirror (const gp_Ax2d &A)
     Performs the symmetrical transformation of a Geometry with respect to an axis placement which is the axis of the symmetry.
    void Rotate (const gp_Pnt2d &P, const double Ang)
     Rotates a Geometry. P is the center of the rotation. Ang is the angular value of the rotation in radians.
    void Scale (const gp_Pnt2d &P, const double S)
     Scales a Geometry. S is the scaling value.
    void Translate (const gp_Vec2d &V)
     Translates a Geometry. V is the vector of the translation.
    void Translate (const gp_Pnt2d &P1, const gp_Pnt2d &P2)
     Translates a Geometry from the point P1 to the point P2.
    occ::handle< Geom2d_GeometryMirrored (const gp_Pnt2d &P) const
    occ::handle< Geom2d_GeometryMirrored (const gp_Ax2d &A) const
    occ::handle< Geom2d_GeometryRotated (const gp_Pnt2d &P, const double Ang) const
    occ::handle< Geom2d_GeometryScaled (const gp_Pnt2d &P, const double S) const
    occ::handle< Geom2d_GeometryTransformed (const gp_Trsf2d &T) const
    occ::handle< Geom2d_GeometryTranslated (const gp_Vec2d &V) const
    occ::handle< Geom2d_GeometryTranslated (const gp_Pnt2d &P1, const gp_Pnt2d &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_Transientoperator= (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_TransientThis () 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.

    Detailed Description

    Describes an axis in 2D 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: Geom2d_AxisPlacement axes provide the same kind of "geometric" services as gp_Ax2d axes but have more complex data structures. The geometric objects provided by the Geom2d package use gp_Ax2d objects to include axes in their data structures, or to define an axis of symmetry or axis of rotation. Geom2d_AxisPlacement axes are used in a context where they can be shared by several objects contained inside a common data structure.

    Constructor & Destructor Documentation

    ◆ Geom2d_AxisPlacement() [1/2]

    Geom2d_AxisPlacement::Geom2d_AxisPlacement ( const gp_Ax2d & A)

    Constructs an axis by conversion of the gp_Ax2d axis A.

    ◆ Geom2d_AxisPlacement() [2/2]

    Geom2d_AxisPlacement::Geom2d_AxisPlacement ( const gp_Pnt2d & P,
    const gp_Dir2d & V )

    Constructs an axis from a given origin P and unit vector V.

    Member Function Documentation

    ◆ Angle()

    double Geom2d_AxisPlacement::Angle ( const occ::handle< Geom2d_AxisPlacement > & Other) const

    Computes the angle between the "Direction" of two axis placement in radians. The result is comprised between -Pi and Pi.

    ◆ Ax2d()

    gp_Ax2d Geom2d_AxisPlacement::Ax2d ( ) const

    Converts this axis into a gp_Ax2d axis.

    ◆ Copy()

    occ::handle< Geom2d_Geometry > Geom2d_AxisPlacement::Copy ( ) const
    overridevirtual

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

    Implements Geom2d_Geometry.

    ◆ Direction()

    gp_Dir2d Geom2d_AxisPlacement::Direction ( ) const

    Returns the "Direction" of <me>. -C++: return const&.

    ◆ Location()

    gp_Pnt2d Geom2d_AxisPlacement::Location ( ) const

    Returns the "Location" point (origin) of the axis placement. -C++: return const&.

    ◆ Reverse()

    void Geom2d_AxisPlacement::Reverse ( )

    ◆ Reversed()

    occ::handle< Geom2d_AxisPlacement > Geom2d_AxisPlacement::Reversed ( ) const
    nodiscard

    Reverses the unit vector of this axis. Note:

    • Reverse assigns the result to this axis, while
    • Reversed creates a new one.

    ◆ SetAxis()

    void Geom2d_AxisPlacement::SetAxis ( const gp_Ax2d & A)

    Changes the complete definition of the axis placement.

    ◆ SetDirection()

    void Geom2d_AxisPlacement::SetDirection ( const gp_Dir2d & V)

    Changes the "Direction" of the axis placement.

    ◆ SetLocation()

    void Geom2d_AxisPlacement::SetLocation ( const gp_Pnt2d & P)

    Changes the "Location" point (origin) of the axis placement.

    ◆ Transform()

    void Geom2d_AxisPlacement::Transform ( const gp_Trsf2d & T)
    overridevirtual

    Applies the transformation T to this axis.

    Implements Geom2d_Geometry.


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