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
    Geom_CartesianPoint Class Reference

    Describes a point in 3D space. A Geom_CartesianPoint is defined by a gp_Pnt point, with its three Cartesian coordinates X, Y and Z. More...

    #include <Geom_CartesianPoint.hxx>

    Inheritance diagram for Geom_CartesianPoint:

    Public Member Functions

     Geom_CartesianPoint (const gp_Pnt &P)
     Returns a transient copy of P.
     Geom_CartesianPoint (const double X, const double Y, const double Z)
     Constructs a point defined by its three Cartesian coordinates X, Y and Z.
    void SetCoord (const double X, const double Y, const double Z)
     Assigns the coordinates X, Y and Z to this point.
    void SetPnt (const gp_Pnt &P)
     Set <me> to P.X(), P.Y(), P.Z() coordinates.
    void SetX (const double X)
     Changes the X coordinate of <me>.
    void SetY (const double Y)
     Changes the Y coordinate of <me>.
    void SetZ (const double Z)
     Changes the Z coordinate of <me>.
    void Coord (double &X, double &Y, double &Z) const override
     Returns the coordinates of <me>.
    gp_Pnt Pnt () const override
     Returns a non transient cartesian point with the same coordinates as <me>.
    double X () const override
     Returns the X coordinate of <me>.
    double Y () const override
     Returns the Y coordinate of <me>.
    double Z () const override
     Returns the Z coordinate of <me>.
    void Transform (const gp_Trsf &T) override
     Applies the transformation T to this point.
    occ::handle< Geom_GeometryCopy () const override
     Creates a new object which is a copy of this point.
    Public Member Functions inherited from Geom_Point
    double Distance (const occ::handle< Geom_Point > &Other) const
     Computes the distance between <me> and <Other>.
    double SquareDistance (const occ::handle< Geom_Point > &Other) const
     Computes the square distance between <me> and <Other>.
    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_GeometryMirrored (const gp_Pnt &P) const
    occ::handle< Geom_GeometryMirrored (const gp_Ax1 &A1) const
    occ::handle< Geom_GeometryMirrored (const gp_Ax2 &A2) const
    occ::handle< Geom_GeometryRotated (const gp_Ax1 &A1, const double Ang) const
    occ::handle< Geom_GeometryScaled (const gp_Pnt &P, const double S) const
    occ::handle< Geom_GeometryTransformed (const gp_Trsf &T) const
    occ::handle< Geom_GeometryTranslated (const gp_Vec &V) const
    occ::handle< Geom_GeometryTranslated (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_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 a point in 3D space. A Geom_CartesianPoint is defined by a gp_Pnt point, with its three Cartesian coordinates X, Y and Z.

    Constructor & Destructor Documentation

    ◆ Geom_CartesianPoint() [1/2]

    Geom_CartesianPoint::Geom_CartesianPoint ( const gp_Pnt & P)

    Returns a transient copy of P.

    ◆ Geom_CartesianPoint() [2/2]

    Geom_CartesianPoint::Geom_CartesianPoint ( const double X,
    const double Y,
    const double Z )

    Constructs a point defined by its three Cartesian coordinates X, Y and Z.

    Member Function Documentation

    ◆ Coord()

    void Geom_CartesianPoint::Coord ( double & X,
    double & Y,
    double & Z ) const
    overridevirtual

    Returns the coordinates of <me>.

    Implements Geom_Point.

    ◆ Copy()

    occ::handle< Geom_Geometry > Geom_CartesianPoint::Copy ( ) const
    overridevirtual

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

    Implements Geom_Geometry.

    ◆ Pnt()

    gp_Pnt Geom_CartesianPoint::Pnt ( ) const
    overridevirtual

    Returns a non transient cartesian point with the same coordinates as <me>.

    Implements Geom_Point.

    ◆ SetCoord()

    void Geom_CartesianPoint::SetCoord ( const double X,
    const double Y,
    const double Z )

    Assigns the coordinates X, Y and Z to this point.

    ◆ SetPnt()

    void Geom_CartesianPoint::SetPnt ( const gp_Pnt & P)

    Set <me> to P.X(), P.Y(), P.Z() coordinates.

    ◆ SetX()

    void Geom_CartesianPoint::SetX ( const double X)

    Changes the X coordinate of <me>.

    ◆ SetY()

    void Geom_CartesianPoint::SetY ( const double Y)

    Changes the Y coordinate of <me>.

    ◆ SetZ()

    void Geom_CartesianPoint::SetZ ( const double Z)

    Changes the Z coordinate of <me>.

    ◆ Transform()

    void Geom_CartesianPoint::Transform ( const gp_Trsf & T)
    overridevirtual

    Applies the transformation T to this point.

    Implements Geom_Geometry.

    ◆ X()

    double Geom_CartesianPoint::X ( ) const
    overridevirtual

    Returns the X coordinate of <me>.

    Implements Geom_Point.

    ◆ Y()

    double Geom_CartesianPoint::Y ( ) const
    overridevirtual

    Returns the Y coordinate of <me>.

    Implements Geom_Point.

    ◆ Z()

    double Geom_CartesianPoint::Z ( ) const
    overridevirtual

    Returns the Z coordinate of <me>.

    Implements Geom_Point.


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