Open CASCADE Technology  7.2.0
Public Member Functions | Data Fields

Graphic3d_CLight Struct Reference

Light definition. More...

#include <Graphic3d_CLight.hxx>

Public Member Functions

Standard_ShortReal ConstAttenuation () const
 Const attenuation factor of positional light source. More...
 
Standard_ShortReal LinearAttenuation () const
 Linear attenuation factor of positional light source. More...
 
Graphic3d_Vec2 Attenuation () const
 Const, Linear attenuation factors of positional light source. More...
 
Standard_ShortReal Angle () const
 Angle in radians of the cone created by the spot. More...
 
Standard_ShortReal Concentration () const
 Intensity distribution of the spot light, with 0..1 range. More...
 
Standard_ShortRealChangeConstAttenuation ()
 
Standard_ShortRealChangeLinearAttenuation ()
 
Graphic3d_Vec2ChangeAttenuation ()
 
Standard_ShortRealChangeAngle ()
 
Standard_ShortRealChangeConcentration ()
 
 Graphic3d_CLight ()
 Empty constructor. More...
 

Data Fields

Graphic3d_Vec3d Position
 light position More...
 
Graphic3d_Vec4 Color
 light color More...
 
Graphic3d_Vec4 Direction
 direction of directional/spot light More...
 
Graphic3d_Vec4 Params
 packed light parameters More...
 
Standard_ShortReal Smoothness
 radius (cone angle) for point (directional) light More...
 
Standard_ShortReal Intensity
 intensity multiplier for light More...
 
Graphic3d_TypeOfLightSource Type
 Graphic3d_TypeOfLightSource enumeration. More...
 
Standard_Boolean IsHeadlight
 flag to mark head light More...
 

Detailed Description

Light definition.

Constructor & Destructor Documentation

◆ Graphic3d_CLight()

Graphic3d_CLight::Graphic3d_CLight ( )
inline

Empty constructor.

Member Function Documentation

◆ Angle()

Standard_ShortReal Graphic3d_CLight::Angle ( ) const
inline

Angle in radians of the cone created by the spot.

◆ Attenuation()

Graphic3d_Vec2 Graphic3d_CLight::Attenuation ( ) const
inline

Const, Linear attenuation factors of positional light source.

◆ ChangeAngle()

Standard_ShortReal& Graphic3d_CLight::ChangeAngle ( )
inline

◆ ChangeAttenuation()

Graphic3d_Vec2& Graphic3d_CLight::ChangeAttenuation ( )
inline

◆ ChangeConcentration()

Standard_ShortReal& Graphic3d_CLight::ChangeConcentration ( )
inline

◆ ChangeConstAttenuation()

Standard_ShortReal& Graphic3d_CLight::ChangeConstAttenuation ( )
inline

◆ ChangeLinearAttenuation()

Standard_ShortReal& Graphic3d_CLight::ChangeLinearAttenuation ( )
inline

◆ Concentration()

Standard_ShortReal Graphic3d_CLight::Concentration ( ) const
inline

Intensity distribution of the spot light, with 0..1 range.

◆ ConstAttenuation()

Standard_ShortReal Graphic3d_CLight::ConstAttenuation ( ) const
inline

Const attenuation factor of positional light source.

◆ LinearAttenuation()

Standard_ShortReal Graphic3d_CLight::LinearAttenuation ( ) const
inline

Linear attenuation factor of positional light source.

Field Documentation

◆ Color

Graphic3d_Vec4 Graphic3d_CLight::Color

light color

◆ Direction

Graphic3d_Vec4 Graphic3d_CLight::Direction

direction of directional/spot light

◆ Intensity

Standard_ShortReal Graphic3d_CLight::Intensity

intensity multiplier for light

◆ IsHeadlight

Standard_Boolean Graphic3d_CLight::IsHeadlight

flag to mark head light

◆ Params

Graphic3d_Vec4 Graphic3d_CLight::Params

packed light parameters

◆ Position

Graphic3d_Vec3d Graphic3d_CLight::Position

light position

◆ Smoothness

Standard_ShortReal Graphic3d_CLight::Smoothness

radius (cone angle) for point (directional) light

◆ Type

Graphic3d_TypeOfLightSource Graphic3d_CLight::Type

Graphic3d_TypeOfLightSource enumeration.


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