OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Aspect_GradientBackground Class Reference

    This class allows the definition of a window gradient background. More...

    #include <Aspect_GradientBackground.hxx>

    Inheritance diagram for Aspect_GradientBackground:

    Public Member Functions

     Aspect_GradientBackground ()
     Creates a window gradient background. Default color is Quantity_NOC_BLACK. Default fill method is Aspect_GradientFillMethod_None.
     Aspect_GradientBackground (const Quantity_Color &theColor1, const Quantity_Color &theColor2, const Aspect_GradientFillMethod theMethod=Aspect_GradientFillMethod_Horizontal)
     Creates a window gradient background with two colours.
    void SetColors (const Quantity_Color &theColor1, const Quantity_Color &theColor2, const Aspect_GradientFillMethod theMethod=Aspect_GradientFillMethod_Horizontal)
     Modifies the colours of the window gradient background.
    void Colors (Quantity_Color &theColor1, Quantity_Color &theColor2) const
     Returns colours of the window gradient background.
    Aspect_GradientFillMethod BgGradientFillMethod () const
     Returns the current gradient background fill mode.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.
    Public Member Functions inherited from Aspect_Background
     Aspect_Background ()
     Creates a window background. Default color : NOC_MATRAGRAY.
     Aspect_Background (const Quantity_Color &AColor)
     Creates a window background with the colour <AColor>.
    void SetColor (const Quantity_Color &AColor)
     Modifies the colour of the window background <me>.
    Quantity_Color Color () const
     Returns the colour of the window background <me>.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.

    Detailed Description

    This class allows the definition of a window gradient background.

    Constructor & Destructor Documentation

    ◆ Aspect_GradientBackground() [1/2]

    Aspect_GradientBackground::Aspect_GradientBackground ( )

    Creates a window gradient background. Default color is Quantity_NOC_BLACK. Default fill method is Aspect_GradientFillMethod_None.

    ◆ Aspect_GradientBackground() [2/2]

    Aspect_GradientBackground::Aspect_GradientBackground ( const Quantity_Color & theColor1,
    const Quantity_Color & theColor2,
    const Aspect_GradientFillMethod theMethod = Aspect_GradientFillMethod_Horizontal )

    Creates a window gradient background with two colours.

    Member Function Documentation

    ◆ BgGradientFillMethod()

    Aspect_GradientFillMethod Aspect_GradientBackground::BgGradientFillMethod ( ) const

    Returns the current gradient background fill mode.

    ◆ Colors()

    void Aspect_GradientBackground::Colors ( Quantity_Color & theColor1,
    Quantity_Color & theColor2 ) const

    Returns colours of the window gradient background.

    ◆ DumpJson()

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

    Dumps the content of me into the stream.

    ◆ SetColors()

    void Aspect_GradientBackground::SetColors ( const Quantity_Color & theColor1,
    const Quantity_Color & theColor2,
    const Aspect_GradientFillMethod theMethod = Aspect_GradientFillMethod_Horizontal )

    Modifies the colours of the window gradient background.


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