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

    specifies a spot light node of VRML nodes specifying properties of lights. This node defines a spotlight light source. A spotlight is placed at a fixed location in 3D-space and illuminates in a cone along a particular direction. The intensity of the illumination drops off exponentially as a ray of light diverges from this direction toward the edges of cone. The rate of drop-off and agle of the cone are controlled by the dropOfRate and cutOffAngle Color is written as an RGB triple. Light intensity must be in the range 0.0 to 1.0, inclusive. More...

    #include <Vrml_SpotLight.hxx>

    Public Member Functions

     Vrml_SpotLight ()
     Vrml_SpotLight (const bool aOnOff, const double aIntensity, const Quantity_Color &aColor, const gp_Vec &aLocation, const gp_Vec &aDirection, const double aDropOffRate, const double aCutOffAngle)
    void SetOnOff (const bool anOnOff)
    bool OnOff () const
    void SetIntensity (const double aIntensity)
    double Intensity () const
    void SetColor (const Quantity_Color &aColor)
    Quantity_Color Color () const
    void SetLocation (const gp_Vec &aLocation)
    gp_Vec Location () const
    void SetDirection (const gp_Vec &aDirection)
    gp_Vec Direction () const
    void SetDropOffRate (const double aDropOffRate)
    double DropOffRate () const
    void SetCutOffAngle (const double aCutOffAngle)
    double CutOffAngle () const
    Standard_OStreamPrint (Standard_OStream &anOStream) const

    Detailed Description

    specifies a spot light node of VRML nodes specifying properties of lights. This node defines a spotlight light source. A spotlight is placed at a fixed location in 3D-space and illuminates in a cone along a particular direction. The intensity of the illumination drops off exponentially as a ray of light diverges from this direction toward the edges of cone. The rate of drop-off and agle of the cone are controlled by the dropOfRate and cutOffAngle Color is written as an RGB triple. Light intensity must be in the range 0.0 to 1.0, inclusive.

    Constructor & Destructor Documentation

    ◆ Vrml_SpotLight() [1/2]

    Vrml_SpotLight::Vrml_SpotLight ( )

    ◆ Vrml_SpotLight() [2/2]

    Vrml_SpotLight::Vrml_SpotLight ( const bool aOnOff,
    const double aIntensity,
    const Quantity_Color & aColor,
    const gp_Vec & aLocation,
    const gp_Vec & aDirection,
    const double aDropOffRate,
    const double aCutOffAngle )

    Member Function Documentation

    ◆ Color()

    Quantity_Color Vrml_SpotLight::Color ( ) const

    ◆ CutOffAngle()

    double Vrml_SpotLight::CutOffAngle ( ) const

    ◆ Direction()

    gp_Vec Vrml_SpotLight::Direction ( ) const

    ◆ DropOffRate()

    double Vrml_SpotLight::DropOffRate ( ) const

    ◆ Intensity()

    double Vrml_SpotLight::Intensity ( ) const

    ◆ Location()

    gp_Vec Vrml_SpotLight::Location ( ) const

    ◆ OnOff()

    bool Vrml_SpotLight::OnOff ( ) const

    ◆ Print()

    Standard_OStream & Vrml_SpotLight::Print ( Standard_OStream & anOStream) const

    ◆ SetColor()

    void Vrml_SpotLight::SetColor ( const Quantity_Color & aColor)

    ◆ SetCutOffAngle()

    void Vrml_SpotLight::SetCutOffAngle ( const double aCutOffAngle)

    ◆ SetDirection()

    void Vrml_SpotLight::SetDirection ( const gp_Vec & aDirection)

    ◆ SetDropOffRate()

    void Vrml_SpotLight::SetDropOffRate ( const double aDropOffRate)

    ◆ SetIntensity()

    void Vrml_SpotLight::SetIntensity ( const double aIntensity)

    ◆ SetLocation()

    void Vrml_SpotLight::SetLocation ( const gp_Vec & aLocation)

    ◆ SetOnOff()

    void Vrml_SpotLight::SetOnOff ( const bool anOnOff)

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