OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    MAT2d_Connexion Class Reference

    A Connexion links two lines of items in a set of lines. It contains two points and their paramatric definitions on the lines. The items can be points or curves. More...

    #include <MAT2d_Connexion.hxx>

    Inheritance diagram for MAT2d_Connexion:

    Public Member Functions

     MAT2d_Connexion ()
     MAT2d_Connexion (const int LineA, const int LineB, const int ItemA, const int ItemB, const double Distance, const double ParameterOnA, const double ParameterOnB, const gp_Pnt2d &PointA, const gp_Pnt2d &PointB)
    int IndexFirstLine () const
     Returns the Index on the first line.
    int IndexSecondLine () const
     Returns the Index on the Second line.
    int IndexItemOnFirst () const
     Returns the Index of the item on the first line.
    int IndexItemOnSecond () const
     Returns the Index of the item on the second line.
    double ParameterOnFirst () const
     Returns the parameter of the point on the firstline.
    double ParameterOnSecond () const
     Returns the parameter of the point on the secondline.
    gp_Pnt2d PointOnFirst () const
     Returns the point on the firstline.
    gp_Pnt2d PointOnSecond () const
     Returns the point on the secondline.
    double Distance () const
     Returns the distance between the two points.
    void IndexFirstLine (const int anIndex)
    void IndexSecondLine (const int anIndex)
    void IndexItemOnFirst (const int anIndex)
    void IndexItemOnSecond (const int anIndex)
    void ParameterOnFirst (const double aParameter)
    void ParameterOnSecond (const double aParameter)
    void PointOnFirst (const gp_Pnt2d &aPoint)
    void PointOnSecond (const gp_Pnt2d &aPoint)
    void Distance (const double aDistance)
    occ::handle< MAT2d_Connexion > Reverse () const
     Returns the reverse connexion of <me>. the firstpoint is the secondpoint. the secondpoint is the firstpoint.
    bool IsAfter (const occ::handle< MAT2d_Connexion > &aConnexion, const double aSense) const
     Returns <True> if my firstPoint is on the same line than the firstpoint of <aConnexion> and my firstpoint is after the firstpoint of <aConnexion> on the line. <aSense> = 1 if <aConnexion> is on the Left of its firstline, else <aSense> = -1.
    void Dump (const int Deep=0, const int Offset=0) const
     Print <me>.
    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.

    Detailed Description

    A Connexion links two lines of items in a set of lines. It contains two points and their paramatric definitions on the lines. The items can be points or curves.

    Constructor & Destructor Documentation

    ◆ MAT2d_Connexion() [1/2]

    MAT2d_Connexion::MAT2d_Connexion ( )

    ◆ MAT2d_Connexion() [2/2]

    MAT2d_Connexion::MAT2d_Connexion ( const int LineA,
    const int LineB,
    const int ItemA,
    const int ItemB,
    const double Distance,
    const double ParameterOnA,
    const double ParameterOnB,
    const gp_Pnt2d & PointA,
    const gp_Pnt2d & PointB )

    Member Function Documentation

    ◆ Distance() [1/2]

    double MAT2d_Connexion::Distance ( ) const

    Returns the distance between the two points.

    ◆ Distance() [2/2]

    void MAT2d_Connexion::Distance ( const double aDistance)

    ◆ Dump()

    void MAT2d_Connexion::Dump ( const int Deep = 0,
    const int Offset = 0 ) const

    Print <me>.

    ◆ IndexFirstLine() [1/2]

    int MAT2d_Connexion::IndexFirstLine ( ) const

    Returns the Index on the first line.

    ◆ IndexFirstLine() [2/2]

    void MAT2d_Connexion::IndexFirstLine ( const int anIndex)

    ◆ IndexItemOnFirst() [1/2]

    int MAT2d_Connexion::IndexItemOnFirst ( ) const

    Returns the Index of the item on the first line.

    ◆ IndexItemOnFirst() [2/2]

    void MAT2d_Connexion::IndexItemOnFirst ( const int anIndex)

    ◆ IndexItemOnSecond() [1/2]

    int MAT2d_Connexion::IndexItemOnSecond ( ) const

    Returns the Index of the item on the second line.

    ◆ IndexItemOnSecond() [2/2]

    void MAT2d_Connexion::IndexItemOnSecond ( const int anIndex)

    ◆ IndexSecondLine() [1/2]

    int MAT2d_Connexion::IndexSecondLine ( ) const

    Returns the Index on the Second line.

    ◆ IndexSecondLine() [2/2]

    void MAT2d_Connexion::IndexSecondLine ( const int anIndex)

    ◆ IsAfter()

    bool MAT2d_Connexion::IsAfter ( const occ::handle< MAT2d_Connexion > & aConnexion,
    const double aSense ) const

    Returns <True> if my firstPoint is on the same line than the firstpoint of <aConnexion> and my firstpoint is after the firstpoint of <aConnexion> on the line. <aSense> = 1 if <aConnexion> is on the Left of its firstline, else <aSense> = -1.

    ◆ ParameterOnFirst() [1/2]

    double MAT2d_Connexion::ParameterOnFirst ( ) const

    Returns the parameter of the point on the firstline.

    ◆ ParameterOnFirst() [2/2]

    void MAT2d_Connexion::ParameterOnFirst ( const double aParameter)

    ◆ ParameterOnSecond() [1/2]

    double MAT2d_Connexion::ParameterOnSecond ( ) const

    Returns the parameter of the point on the secondline.

    ◆ ParameterOnSecond() [2/2]

    void MAT2d_Connexion::ParameterOnSecond ( const double aParameter)

    ◆ PointOnFirst() [1/2]

    gp_Pnt2d MAT2d_Connexion::PointOnFirst ( ) const

    Returns the point on the firstline.

    ◆ PointOnFirst() [2/2]

    void MAT2d_Connexion::PointOnFirst ( const gp_Pnt2d & aPoint)

    ◆ PointOnSecond() [1/2]

    gp_Pnt2d MAT2d_Connexion::PointOnSecond ( ) const

    Returns the point on the secondline.

    ◆ PointOnSecond() [2/2]

    void MAT2d_Connexion::PointOnSecond ( const gp_Pnt2d & aPoint)

    ◆ Reverse()

    occ::handle< MAT2d_Connexion > MAT2d_Connexion::Reverse ( ) const

    Returns the reverse connexion of <me>. the firstpoint is the secondpoint. the secondpoint is the firstpoint.


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