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

    Describes a coordinate transformation, i.e. a change to an elementary 3D coordinate system, or position in 3D space. A Datum3D is always described relative to the default datum. The default datum is described relative to itself: its origin is (0,0,0), and its axes are (1,0,0) (0,1,0) (0,0,1). More...

    #include <TopLoc_Datum3D.hxx>

    Inheritance diagram for TopLoc_Datum3D:

    Public Member Functions

     TopLoc_Datum3D ()
     Constructs a default Datum3D.
     TopLoc_Datum3D (const gp_Trsf &T)
     Constructs a Datum3D form a Trsf from gp. An error is raised if the Trsf is not a rigid transformation.
    const gp_TrsfTransformation () const
     Returns a gp_Trsf which, when applied to this datum, produces the default datum.
    const gp_TrsfTrsf () const
     Returns a gp_Trsf which, when applied to this datum, produces the default datum.
    gp_TrsfForm Form () const
     Return transformation form.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.
    void ShallowDump (Standard_OStream &S) const
     Writes the contents of this Datum3D to the stream S.
    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 coordinate transformation, i.e. a change to an elementary 3D coordinate system, or position in 3D space. A Datum3D is always described relative to the default datum. The default datum is described relative to itself: its origin is (0,0,0), and its axes are (1,0,0) (0,1,0) (0,0,1).

    Constructor & Destructor Documentation

    ◆ TopLoc_Datum3D() [1/2]

    TopLoc_Datum3D::TopLoc_Datum3D ( )

    Constructs a default Datum3D.

    ◆ TopLoc_Datum3D() [2/2]

    TopLoc_Datum3D::TopLoc_Datum3D ( const gp_Trsf & T)

    Constructs a Datum3D form a Trsf from gp. An error is raised if the Trsf is not a rigid transformation.

    Member Function Documentation

    ◆ DumpJson()

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

    Dumps the content of me into the stream.

    ◆ Form()

    gp_TrsfForm TopLoc_Datum3D::Form ( ) const
    inline

    Return transformation form.

    ◆ ShallowDump()

    void TopLoc_Datum3D::ShallowDump ( Standard_OStream & S) const

    Writes the contents of this Datum3D to the stream S.

    ◆ Transformation()

    const gp_Trsf & TopLoc_Datum3D::Transformation ( ) const
    inline

    Returns a gp_Trsf which, when applied to this datum, produces the default datum.

    ◆ Trsf()

    const gp_Trsf & TopLoc_Datum3D::Trsf ( ) const
    inline

    Returns a gp_Trsf which, when applied to this datum, produces the default datum.


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