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

    A framework to define the display of shading. The attributes which make up this definition include: More...

    #include <Prs3d_ShadingAspect.hxx>

    Inheritance diagram for Prs3d_ShadingAspect:
    Inheritance graph
    [legend]

    Public Member Functions

     Prs3d_ShadingAspect ()
     Constructs an empty framework to display shading.
     Prs3d_ShadingAspect (const occ::handle< Graphic3d_AspectFillArea3d > &theAspect)
     Constructor with initialization.
    void SetColor (const Quantity_Color &aColor, const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_BOTH_SIDE)
     Change the polygons interior color and material ambient color.
    void SetMaterial (const Graphic3d_MaterialAspect &aMaterial, const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_BOTH_SIDE)
     Change the polygons material aspect.
    void SetTransparency (const double aValue, const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_BOTH_SIDE)
     Change the polygons transparency value. Warning : aValue must be in the range 0,1. 0 is the default (NO transparent).
    const Quantity_Color & Color (const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_FRONT_SIDE) const
     Returns the polygons color.
    const Graphic3d_MaterialAspect & Material (const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_FRONT_SIDE) const
     Returns the polygons material aspect.
    double Transparency (const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_FRONT_SIDE) const
     Returns the polygons transparency value.
    bool ToUseVertexColorForBackFaces () const
     Return true if per-vertex color should be applied to back-facing fragments.
    void SetUseVertexColorForBackFaces (bool theToUse)
     Set whether per-vertex color should be applied to back-facing fragments.
    const occ::handle< Graphic3d_AspectFillArea3d > & Aspect () const
     Returns the polygons aspect properties.
    void SetAspect (const occ::handle< Graphic3d_AspectFillArea3d > &theAspect)
    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_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.

    Protected Attributes

    occ::handle< Graphic3d_AspectFillArea3d > myAspect

    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 framework to define the display of shading. The attributes which make up this definition include:

    • fill aspect
    • color, and
    • material

    Constructor & Destructor Documentation

    ◆ Prs3d_ShadingAspect() [1/2]

    Prs3d_ShadingAspect::Prs3d_ShadingAspect ( )

    Constructs an empty framework to display shading.

    ◆ Prs3d_ShadingAspect() [2/2]

    Prs3d_ShadingAspect::Prs3d_ShadingAspect ( const occ::handle< Graphic3d_AspectFillArea3d > & theAspect)
    		inline

    Constructor with initialization.

    Member Function Documentation

    ◆ Aspect()

    const occ::handle< Graphic3d_AspectFillArea3d > & Prs3d_ShadingAspect::Aspect ( ) const
    		inline

    Returns the polygons aspect properties.

    ◆ Color()

    const Quantity_Color & Prs3d_ShadingAspect::Color ( const Aspect_TypeOfFacingModel aModel = Aspect_TOFM_FRONT_SIDE) const

    Returns the polygons color.

    ◆ DumpJson()

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

    Dumps the content of me into the stream.

    Implements Prs3d_BasicAspect.

    ◆ Material()

    const Graphic3d_MaterialAspect & Prs3d_ShadingAspect::Material ( const Aspect_TypeOfFacingModel aModel = Aspect_TOFM_FRONT_SIDE) const

    Returns the polygons material aspect.

    ◆ SetAspect()

    void Prs3d_ShadingAspect::SetAspect ( const occ::handle< Graphic3d_AspectFillArea3d > & theAspect)
    		inline

    ◆ SetColor()

    void Prs3d_ShadingAspect::SetColor ( const Quantity_Color & aColor,
    const Aspect_TypeOfFacingModel aModel = Aspect_TOFM_BOTH_SIDE )

    Change the polygons interior color and material ambient color.

    ◆ SetMaterial()

    void Prs3d_ShadingAspect::SetMaterial ( const Graphic3d_MaterialAspect & aMaterial,
    const Aspect_TypeOfFacingModel aModel = Aspect_TOFM_BOTH_SIDE )

    Change the polygons material aspect.

    ◆ SetTransparency()

    void Prs3d_ShadingAspect::SetTransparency ( const double aValue,
    const Aspect_TypeOfFacingModel aModel = Aspect_TOFM_BOTH_SIDE )

    Change the polygons transparency value. Warning : aValue must be in the range 0,1. 0 is the default (NO transparent).

    ◆ SetUseVertexColorForBackFaces()

    void Prs3d_ShadingAspect::SetUseVertexColorForBackFaces ( bool theToUse)
    		inline

    Set whether per-vertex color should be applied to back-facing fragments.

    ◆ ToUseVertexColorForBackFaces()

    bool Prs3d_ShadingAspect::ToUseVertexColorForBackFaces ( ) const
    		inline

    Return true if per-vertex color should be applied to back-facing fragments.

    ◆ Transparency()

    double Prs3d_ShadingAspect::Transparency ( const Aspect_TypeOfFacingModel aModel = Aspect_TOFM_FRONT_SIDE) const

    Returns the polygons transparency value.

    Field Documentation

    ◆ myAspect

    occ::handle<Graphic3d_AspectFillArea3d> Prs3d_ShadingAspect::myAspect
    		protected
    The documentation for this class was generated from the following file: