Open CASCADE Technology  7.1.0.beta
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends

V3d_Light Class Reference

Defines services on Light type objects.. (base class for AmbientLight and PositionLight) More...

#include <V3d_Light.hxx>

Inheritance diagram for V3d_Light:
Inheritance graph
[legend]

Public Member Functions

void SetColor (const Quantity_TypeOfColor theType, const Quantity_Parameter theValue1, const Quantity_Parameter theValue2, const Quantity_Parameter theValue3)
 Defines the color of a light source according to the type of color definition and the three corresponding values. More...
 
void SetColor (const Quantity_NameOfColor theName)
 Defines the color of a light source by giving the name of the color in the form Quantity_NOC_xxxx. More...
 
void SetColor (const Quantity_Color &theColor)
 Defines the color of a light source by giving the basic color. More...
 
void Color (const Quantity_TypeOfColor theType, Quantity_Parameter &theValue1, Quantity_Parameter &theValue2, Quantity_Parameter &theValue3) const
 Returns the color of the light source depending of the color type. More...
 
void Color (Quantity_NameOfColor &theName) const
 Returns the color of the light source. More...
 
Quantity_Color Color () const
 Returns the color of the light source. More...
 
V3d_TypeOfLight Type () const
 Returns the Type of the Light. More...
 
Standard_Boolean Headlight () const
 returns true if the light is a headlight More...
 
void SetHeadlight (const Standard_Boolean theValue)
 Setup headlight flag. More...
 
void SetIntensity (const Standard_Real theValue)
 Modifies the intensity of light source. More...
 
Standard_Real Intensity () const
 returns the intensity of light source More...
 
Standard_Real Smoothness () const
 returns the smoothness of light source More...
 
Standard_Boolean IsDisplayed () const
 Returns TRUE when a light representation is displayed. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const override
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. 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_TransientThis () 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...
 

Protected Member Functions

 V3d_Light (const Handle< V3d_Viewer > &theViewer)
 
void SetType (const V3d_TypeOfLight theType)
 Sets type of the light. More...
 
const Graphic3d_CLightLight () const
 Return light properties associated to this light source. Hidden method exposed only to V3d_View. More...
 

Static Protected Member Functions

static void SymetricPointOnSphere (const Handle< V3d_View > &aView, const Graphic3d_Vertex &Center, const Graphic3d_Vertex &aPoint, const Quantity_Parameter Radius, V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z, Quantity_Parameter &VX, Quantity_Parameter &VY, Quantity_Parameter &VZ)
 Returns the symetric point coordinates of "aPoint" on the sphere of center "Center" and radius "Radius". VX,VY,VZ is the project vector of view. More...
 

Protected Attributes

Graphic3d_CLight myLight
 
Handle< Graphic3d_StructuremyGraphicStructure
 
Handle< Graphic3d_StructuremyGraphicStructure1
 

Friends

void V3d_View::UpdateLights () const
 Updates the lights of the view. The view is redrawn. 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

Defines services on Light type objects.. (base class for AmbientLight and PositionLight)

Constructor & Destructor Documentation

V3d_Light::V3d_Light ( const Handle< V3d_Viewer > &  theViewer)
protected

Member Function Documentation

void V3d_Light::Color ( const Quantity_TypeOfColor  theType,
Quantity_Parameter theValue1,
Quantity_Parameter theValue2,
Quantity_Parameter theValue3 
) const

Returns the color of the light source depending of the color type.

void V3d_Light::Color ( Quantity_NameOfColor theName) const

Returns the color of the light source.

Quantity_Color V3d_Light::Color ( ) const

Returns the color of the light source.

Standard_Boolean V3d_Light::Headlight ( ) const

returns true if the light is a headlight

Standard_Real V3d_Light::Intensity ( ) const

returns the intensity of light source

Standard_Boolean V3d_Light::IsDisplayed ( ) const

Returns TRUE when a light representation is displayed.

const Graphic3d_CLight& V3d_Light::Light ( ) const
inlineprotected

Return light properties associated to this light source. Hidden method exposed only to V3d_View.

void V3d_Light::SetColor ( const Quantity_TypeOfColor  theType,
const Quantity_Parameter  theValue1,
const Quantity_Parameter  theValue2,
const Quantity_Parameter  theValue3 
)

Defines the color of a light source according to the type of color definition and the three corresponding values.

void V3d_Light::SetColor ( const Quantity_NameOfColor  theName)

Defines the color of a light source by giving the name of the color in the form Quantity_NOC_xxxx.

void V3d_Light::SetColor ( const Quantity_Color theColor)

Defines the color of a light source by giving the basic color.

void V3d_Light::SetHeadlight ( const Standard_Boolean  theValue)

Setup headlight flag.

void V3d_Light::SetIntensity ( const Standard_Real  theValue)

Modifies the intensity of light source.

void V3d_Light::SetType ( const V3d_TypeOfLight  theType)
protected

Sets type of the light.

Standard_Real V3d_Light::Smoothness ( ) const

returns the smoothness of light source

static void V3d_Light::SymetricPointOnSphere ( const Handle< V3d_View > &  aView,
const Graphic3d_Vertex Center,
const Graphic3d_Vertex aPoint,
const Quantity_Parameter  Radius,
V3d_Coordinate X,
V3d_Coordinate Y,
V3d_Coordinate Z,
Quantity_Parameter VX,
Quantity_Parameter VY,
Quantity_Parameter VZ 
)
staticprotected

Returns the symetric point coordinates of "aPoint" on the sphere of center "Center" and radius "Radius". VX,VY,VZ is the project vector of view.

V3d_TypeOfLight V3d_Light::Type ( ) const

Returns the Type of the Light.

Friends And Related Function Documentation

void V3d_View::UpdateLights ( ) const
friend

Updates the lights of the view. The view is redrawn.

Field Documentation

Handle< Graphic3d_Structure > V3d_Light::myGraphicStructure
protected
Handle< Graphic3d_Structure > V3d_Light::myGraphicStructure1
protected
Graphic3d_CLight V3d_Light::myLight
protected

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