Generic light source definition. This class defines arbitrary light source - see Graphic3d_TypeOfLightSource enumeration. Some parameters are applicable only to particular light type; calling methods unrelated to current type will throw an exception. More...
#include <Graphic3d_CLight.hxx>
Public Member Functions | |
| Graphic3d_CLight (Graphic3d_TypeOfLightSource theType) | |
| Empty constructor, which should be followed by light source properties configuration. More... | |
| Graphic3d_TypeOfLightSource | Type () const |
| Returns the Type of the Light, cannot be changed after object construction. More... | |
| const TCollection_AsciiString & | Name () const |
| Returns light source name; empty string by default. More... | |
| void | SetName (const TCollection_AsciiString &theName) |
| Sets light source name. More... | |
| const Quantity_Color & | Color () const |
| Returns the color of the light source; WHITE by default. More... | |
| void | SetColor (const Quantity_Color &theColor) |
| Defines the color of a light source by giving the basic color. More... | |
| Standard_Boolean | IsEnabled () const |
| Check that the light source is turned on; TRUE by default. This flag affects all occurrences of light sources, where it was registered and activated; so that it is possible defining an active light in View which is actually in disabled state. More... | |
| void | SetEnabled (Standard_Boolean theIsOn) |
| Change enabled state of the light state. This call does not remove or deactivate light source in Views/Viewers; instead it turns it OFF so that it just have no effect. More... | |
| Standard_Boolean | IsHeadlight () const |
| Returns true if the light is a headlight; FALSE by default. Headlight flag means that light position/direction are defined not in a World coordinate system, but relative to the camera orientation. More... | |
| Standard_Boolean | Headlight () const |
| Alias for IsHeadlight(). More... | |
| void | SetHeadlight (Standard_Boolean theValue) |
| Setup headlight flag. More... | |
positional/spot light properties | |
| const gp_Pnt & | Position () const |
| Returns location of positional/spot light; (0, 0, 0) by default. More... | |
| void | SetPosition (const gp_Pnt &thePosition) |
| Setup location of positional/spot light. More... | |
| void | Position (Standard_Real &theX, Standard_Real &theY, Standard_Real &theZ) const |
| Returns location of positional/spot light. More... | |
| void | SetPosition (Standard_Real theX, Standard_Real theY, Standard_Real theZ) |
| Setup location of positional/spot light. More... | |
| Standard_ShortReal | ConstAttenuation () const |
| Returns constant attenuation factor of positional/spot light source; 1.0f by default. Distance attenuation factors of reducing positional/spot light intensity depending on the distance from its position: More... | |
| Standard_ShortReal | LinearAttenuation () const |
| Returns linear attenuation factor of positional/spot light source; 0.0 by default. Distance attenuation factors of reducing positional/spot light intensity depending on the distance from its position: More... | |
| void | Attenuation (Standard_Real &theConstAttenuation, Standard_Real &theLinearAttenuation) const |
| Returns the attenuation factors. More... | |
| void | SetAttenuation (Standard_ShortReal theConstAttenuation, Standard_ShortReal theLinearAttenuation) |
| Defines the coefficients of attenuation; values should be >= 0.0 and their summ should not be equal to 0. More... | |
directional/spot light additional properties | |
| gp_Dir | Direction () const |
| Returns direction of directional/spot light. More... | |
| void | SetDirection (const gp_Dir &theDir) |
| Sets direction of directional/spot light. More... | |
| void | Direction (Standard_Real &theVx, Standard_Real &theVy, Standard_Real &theVz) const |
| Returns the theVx, theVy, theVz direction of the light source. More... | |
| void | SetDirection (Standard_Real theVx, Standard_Real theVy, Standard_Real theVz) |
| Sets direction of directional/spot light. More... | |
spotlight additional definition parameters | |
| Standard_ShortReal | Angle () const |
| Returns an angle in radians of the cone created by the spot; 30 degrees by default. More... | |
| void | SetAngle (Standard_ShortReal theAngle) |
| Angle in radians of the cone created by the spot, should be within range (0.0, M_PI). More... | |
| Standard_ShortReal | Concentration () const |
| Returns intensity distribution of the spot light, within [0.0, 1.0] range; 1.0 by default. This coefficient should be converted into spotlight exponent within [0.0, 128.0] range: More... | |
| void | SetConcentration (Standard_ShortReal theConcentration) |
| Defines the coefficient of concentration; value should be within range [0.0, 1.0]. More... | |
Ray-Tracing / Path-Tracing light properties | |
| Standard_ShortReal | Intensity () const |
| Returns the intensity of light source; 1.0 by default. More... | |
| void | SetIntensity (Standard_ShortReal theValue) |
| Modifies the intensity of light source, which should be > 0.0. More... | |
| Standard_ShortReal | Smoothness () const |
| Returns the smoothness of light source (either smoothing angle for directional light or smoothing radius in case of positional light); 0.0 by default. More... | |
| void | SetSmoothRadius (Standard_ShortReal theValue) |
| Modifies the smoothing radius of positional/spot light; should be >= 0.0. More... | |
| void | SetSmoothAngle (Standard_ShortReal theValue) |
| Modifies the smoothing angle (in radians) of directional light source; should be within range [0.0, M_PI/2]. More... | |
| Standard_ShortReal | Range () const |
| Returns maximum distance on which point light source affects to objects and is considered during illumination calculations. 0.0 means disabling range considering at all without any distance limits. Has sense only for point light sources (positional and spot). More... | |
| void | SetRange (Standard_ShortReal theValue) |
| Modifies maximum distance on which point light source affects to objects and is considered during illumination calculations. Positional and spot lights are only point light sources. 0.0 means disabling range considering at all without any distance limits. More... | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | 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. More... | |
| Standard_Boolean | IsKind (const Standard_CString 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. More... | |
| 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. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
low-level access methods | |
| TCollection_AsciiString | myId |
| resource id More... | |
| TCollection_AsciiString | myName |
| user given name More... | |
| gp_Pnt | myPosition |
| light position More... | |
| Quantity_ColorRGBA | myColor |
| light color More... | |
| Graphic3d_Vec4 | myDirection |
| direction of directional/spot light More... | |
| Graphic3d_Vec4 | myParams |
| packed light parameters More... | |
| Standard_ShortReal | mySmoothness |
| radius for point light or cone angle for directional light More... | |
| Standard_ShortReal | myIntensity |
| intensity multiplier for light More... | |
| const Graphic3d_TypeOfLightSource | myType |
| Graphic3d_TypeOfLightSource enumeration. More... | |
| Standard_Size | myRevision |
| modification counter More... | |
| Standard_Boolean | myIsHeadlight |
| flag to mark head light More... | |
| Standard_Boolean | myIsEnabled |
| enabled state More... | |
| const TCollection_AsciiString & | GetId () const |
| const Graphic3d_Vec4 & | PackedParams () const |
| Packed light parameters. More... | |
| const Graphic3d_Vec4 & | PackedColor () const |
| Returns the color of the light source with dummy Alpha component, which should be ignored. More... | |
| const Graphic3d_Vec4 & | PackedDirectionRange () const |
| Returns direction of directional/spot light and range for positional/spot light in alpha channel. More... | |
| Standard_Size | Revision () const |
| void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const |
| Dumps the content of me into the stream. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Detailed Description
Generic light source definition. This class defines arbitrary light source - see Graphic3d_TypeOfLightSource enumeration. Some parameters are applicable only to particular light type; calling methods unrelated to current type will throw an exception.
Constructor & Destructor Documentation
◆ Graphic3d_CLight()
| Graphic3d_CLight::Graphic3d_CLight | ( | Graphic3d_TypeOfLightSource | theType | ) |
Empty constructor, which should be followed by light source properties configuration.
Member Function Documentation
◆ Angle()
|
inline |
Returns an angle in radians of the cone created by the spot; 30 degrees by default.
◆ Attenuation()
|
inline |
Returns the attenuation factors.
◆ Color()
|
inline |
Returns the color of the light source; WHITE by default.
◆ Concentration()
|
inline |
Returns intensity distribution of the spot light, within [0.0, 1.0] range; 1.0 by default. This coefficient should be converted into spotlight exponent within [0.0, 128.0] range:
The concentration factor determines the dispersion of the light on the surface, the default value (1.0) corresponds to a minimum of dispersion.
◆ ConstAttenuation()
|
inline |
Returns constant attenuation factor of positional/spot light source; 1.0f by default. Distance attenuation factors of reducing positional/spot light intensity depending on the distance from its position:
◆ Direction() [1/2]
|
inline |
Returns direction of directional/spot light.
◆ Direction() [2/2]
|
inline |
Returns the theVx, theVy, theVz direction of the light source.
◆ DumpJson()
| void Graphic3d_CLight::DumpJson | ( | Standard_OStream & | theOStream, |
| Standard_Integer | theDepth = -1 |
||
| ) | const |
Dumps the content of me into the stream.
◆ GetId()
|
inline |
- Returns
- light resource identifier string
◆ Headlight()
|
inline |
Alias for IsHeadlight().
◆ Intensity()
|
inline |
Returns the intensity of light source; 1.0 by default.
◆ IsEnabled()
|
inline |
Check that the light source is turned on; TRUE by default. This flag affects all occurrences of light sources, where it was registered and activated; so that it is possible defining an active light in View which is actually in disabled state.
◆ IsHeadlight()
|
inline |
Returns true if the light is a headlight; FALSE by default. Headlight flag means that light position/direction are defined not in a World coordinate system, but relative to the camera orientation.
◆ LinearAttenuation()
|
inline |
Returns linear attenuation factor of positional/spot light source; 0.0 by default. Distance attenuation factors of reducing positional/spot light intensity depending on the distance from its position:
◆ Name()
|
inline |
Returns light source name; empty string by default.
◆ PackedColor()
|
inline |
Returns the color of the light source with dummy Alpha component, which should be ignored.
◆ PackedDirectionRange()
|
inline |
Returns direction of directional/spot light and range for positional/spot light in alpha channel.
◆ PackedParams()
|
inline |
Packed light parameters.
◆ Position() [1/2]
|
inline |
Returns location of positional/spot light; (0, 0, 0) by default.
◆ Position() [2/2]
|
inline |
Returns location of positional/spot light.
◆ Range()
|
inline |
Returns maximum distance on which point light source affects to objects and is considered during illumination calculations. 0.0 means disabling range considering at all without any distance limits. Has sense only for point light sources (positional and spot).
◆ Revision()
|
inline |
- Returns
- modification counter
◆ SetAngle()
| void Graphic3d_CLight::SetAngle | ( | Standard_ShortReal | theAngle | ) |
Angle in radians of the cone created by the spot, should be within range (0.0, M_PI).
◆ SetAttenuation()
| void Graphic3d_CLight::SetAttenuation | ( | Standard_ShortReal | theConstAttenuation, |
| Standard_ShortReal | theLinearAttenuation | ||
| ) |
Defines the coefficients of attenuation; values should be >= 0.0 and their summ should not be equal to 0.
◆ SetColor()
| void Graphic3d_CLight::SetColor | ( | const Quantity_Color & | theColor | ) |
Defines the color of a light source by giving the basic color.
◆ SetConcentration()
| void Graphic3d_CLight::SetConcentration | ( | Standard_ShortReal | theConcentration | ) |
Defines the coefficient of concentration; value should be within range [0.0, 1.0].
◆ SetDirection() [1/2]
| void Graphic3d_CLight::SetDirection | ( | const gp_Dir & | theDir | ) |
Sets direction of directional/spot light.
◆ SetDirection() [2/2]
|
inline |
Sets direction of directional/spot light.
◆ SetEnabled()
| void Graphic3d_CLight::SetEnabled | ( | Standard_Boolean | theIsOn | ) |
Change enabled state of the light state. This call does not remove or deactivate light source in Views/Viewers; instead it turns it OFF so that it just have no effect.
◆ SetHeadlight()
| void Graphic3d_CLight::SetHeadlight | ( | Standard_Boolean | theValue | ) |
Setup headlight flag.
◆ SetIntensity()
| void Graphic3d_CLight::SetIntensity | ( | Standard_ShortReal | theValue | ) |
Modifies the intensity of light source, which should be > 0.0.
◆ SetName()
|
inline |
Sets light source name.
◆ SetPosition() [1/2]
| void Graphic3d_CLight::SetPosition | ( | const gp_Pnt & | thePosition | ) |
Setup location of positional/spot light.
◆ SetPosition() [2/2]
|
inline |
Setup location of positional/spot light.
◆ SetRange()
| void Graphic3d_CLight::SetRange | ( | Standard_ShortReal | theValue | ) |
Modifies maximum distance on which point light source affects to objects and is considered during illumination calculations. Positional and spot lights are only point light sources. 0.0 means disabling range considering at all without any distance limits.
◆ SetSmoothAngle()
| void Graphic3d_CLight::SetSmoothAngle | ( | Standard_ShortReal | theValue | ) |
Modifies the smoothing angle (in radians) of directional light source; should be within range [0.0, M_PI/2].
◆ SetSmoothRadius()
| void Graphic3d_CLight::SetSmoothRadius | ( | Standard_ShortReal | theValue | ) |
Modifies the smoothing radius of positional/spot light; should be >= 0.0.
◆ Smoothness()
|
inline |
Returns the smoothness of light source (either smoothing angle for directional light or smoothing radius in case of positional light); 0.0 by default.
◆ Type()
|
inline |
Returns the Type of the Light, cannot be changed after object construction.
Field Documentation
◆ myColor
|
protected |
light color
◆ myDirection
|
protected |
direction of directional/spot light
◆ myId
|
protected |
resource id
◆ myIntensity
|
protected |
intensity multiplier for light
◆ myIsEnabled
|
protected |
enabled state
◆ myIsHeadlight
|
protected |
flag to mark head light
◆ myName
|
protected |
user given name
◆ myParams
|
protected |
packed light parameters
◆ myPosition
|
protected |
light position
◆ myRevision
|
protected |
modification counter
◆ mySmoothness
|
protected |
radius for point light or cone angle for directional light
◆ myType
|
protected |
Graphic3d_TypeOfLightSource enumeration.
The documentation for this class was generated from the following file:
