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

    This class defines attributes for the points The points are drawn using markers, whose size does not depend on the zoom value of the views. More...

    #include <Prs3d_PointAspect.hxx>

    Inheritance diagram for Prs3d_PointAspect:

    Public Member Functions

     Prs3d_PointAspect (const Aspect_TypeOfMarker theType, const Quantity_Color &theColor, const double theScale)
     Prs3d_PointAspect (const Quantity_Color &theColor, const int theWidth, const int theHeight, const occ::handle< NCollection_HArray1< uint8_t > > &theTexture)
     Defines the user defined marker point.
     Prs3d_PointAspect (const occ::handle< Graphic3d_AspectMarker3d > &theAspect)
    void SetColor (const Quantity_Color &theColor)
     defines the color to be used when drawing a point. Default value: Quantity_NOC_YELLOW
    void SetTypeOfMarker (const Aspect_TypeOfMarker theType)
     defines the type of representation to be used when drawing a point. Default value: Aspect_TOM_PLUS
    void SetScale (const double theScale)
     defines the size of the marker used when drawing a point. Default value: 1.
    const occ::handle< Graphic3d_AspectMarker3d > & Aspect () const
    void SetAspect (const occ::handle< Graphic3d_AspectMarker3d > &theAspect)
    void GetTextureSize (int &theWidth, int &theHeight) const
     Returns marker's texture size.
    const occ::handle< Graphic3d_MarkerImage > & GetTexture () const
     Returns marker's texture.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     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.

    Protected Attributes

    occ::handle< Graphic3d_AspectMarker3dmyAspect

    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

    This class defines attributes for the points The points are drawn using markers, whose size does not depend on the zoom value of the views.

    Constructor & Destructor Documentation

    ◆ Prs3d_PointAspect() [1/3]

    Prs3d_PointAspect::Prs3d_PointAspect ( const Aspect_TypeOfMarker theType,
    const Quantity_Color & theColor,
    const double theScale )

    ◆ Prs3d_PointAspect() [2/3]

    Prs3d_PointAspect::Prs3d_PointAspect ( const Quantity_Color & theColor,
    const int theWidth,
    const int theHeight,
    const occ::handle< NCollection_HArray1< uint8_t > > & theTexture )

    Defines the user defined marker point.

    ◆ Prs3d_PointAspect() [3/3]

    Prs3d_PointAspect::Prs3d_PointAspect ( const occ::handle< Graphic3d_AspectMarker3d > & theAspect)
    inline

    Member Function Documentation

    ◆ Aspect()

    const occ::handle< Graphic3d_AspectMarker3d > & Prs3d_PointAspect::Aspect ( ) const
    inline

    ◆ DumpJson()

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

    Dumps the content of me into the stream.

    Implements Prs3d_BasicAspect.

    ◆ GetTexture()

    const occ::handle< Graphic3d_MarkerImage > & Prs3d_PointAspect::GetTexture ( ) const
    inline

    Returns marker's texture.

    ◆ GetTextureSize()

    void Prs3d_PointAspect::GetTextureSize ( int & theWidth,
    int & theHeight ) const
    inline

    Returns marker's texture size.

    ◆ SetAspect()

    void Prs3d_PointAspect::SetAspect ( const occ::handle< Graphic3d_AspectMarker3d > & theAspect)
    inline

    ◆ SetColor()

    void Prs3d_PointAspect::SetColor ( const Quantity_Color & theColor)
    inline

    defines the color to be used when drawing a point. Default value: Quantity_NOC_YELLOW

    ◆ SetScale()

    void Prs3d_PointAspect::SetScale ( const double theScale)
    inline

    defines the size of the marker used when drawing a point. Default value: 1.

    ◆ SetTypeOfMarker()

    void Prs3d_PointAspect::SetTypeOfMarker ( const Aspect_TypeOfMarker theType)
    inline

    defines the type of representation to be used when drawing a point. Default value: Aspect_TOM_PLUS

    Field Documentation

    ◆ myAspect

    occ::handle<Graphic3d_AspectMarker3d> Prs3d_PointAspect::myAspect
    protected

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