OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
V3d


V3d_PositionalLight Class Reference

Creation and modification of an isolated
light source.
.

#include <V3d_PositionalLight.hxx>

Inheritance diagram for V3d_PositionalLight:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT V3d_PositionalLight (const Handle(V3d_Viewer)&VM, const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, const Quantity_NameOfColor Color=Quantity_NOC_WHITE, const Quantity_Coefficient Attenuation1=1.0, const Quantity_Coefficient Attenuation2=0.0)
 Creates an isolated light source X,Y,Z in the viewer.
It is also defined by the color Color and
two attenuation factors Attenuation1, Attenuation2.
The resulting attenuation factor determining the
illumination of a surface depends on the following
formula :
F = 1/(A1 + A2*Length)
A1,A2 being the two factors of attenuation
Length is the distance of the isolated source
from the surface.
//! Warning! raises BadValue from Viewer
if one of the attenuation coefficients is not between 0 et 1.
.
Standard_EXPORT V3d_PositionalLight (const Handle(V3d_Viewer)&VM, const V3d_Coordinate Xt, const V3d_Coordinate Yt, const V3d_Coordinate Zt, const V3d_Coordinate Xp, const V3d_Coordinate Yp, const V3d_Coordinate Zp, const Quantity_NameOfColor Color=Quantity_NOC_WHITE, const Quantity_Coefficient Attenuation1=1.0, const Quantity_Coefficient Attenuation2=0.0)
 Creates a light source of the Positional type
in the viewer.
Xt,Yt,Zt : Coordinate of Target light source.
Xp,Yp,Zp : Coordinate of Position light source.
The light source is also defined by the color Color
and two attenuation factors Attenuation1,
Attenuation2 that determine the illumination of a
surface using the following formula :
F = 1/(A1 + A2*Length) where:
- A1,A2 are the two attenuation factors, and
- Length is the distance from the isolated source.
//! Warning! raises BadValue from Viewer
if one of the attenuation coefficients is not between 0 et 1.
.
virtual Standard_EXPORT void SetPosition (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z)
 Defines the position of the light source.
.
Standard_EXPORT void SetAttenuation (const Quantity_Coefficient A1, const Quantity_Coefficient A2)
 Defines the attenuation factors.
Warning: raises BadValue from Viewer
if one of the attenuation coefficients is not between 0 et 1.
.
Standard_EXPORT void Display (const Handle(V3d_View)&aView, const V3d_TypeOfRepresentation Representation)
 Display the graphic structure of light source
in the choosen view. We have three type of representation
- SIMPLE : Only the light source is displayed.
- PARTIAL : The light source and the light space are
displayed.
- COMPLETE : The light source, the light space and the
radius of light space are displayed.
We can choose the "SAMELAST" as parameter of representation
In this case the graphic structure representation will be
the last displayed.
.
Standard_EXPORT void Position (V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z) const
 Returns the position of the light source.
.
Standard_EXPORT void Attenuation (Quantity_Coefficient &A1, Quantity_Coefficient &A2) const
 Returns the attenuation factors A1,A2 of the light
source used at construction time.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Member Functions

Standard_EXPORT void Symbol (const Handle(Graphic3d_Group)&gsymbol, const Handle(V3d_View)&aView) const
 Defined the representation of the positional light source.
.

Constructor & Destructor Documentation

Standard_EXPORT V3d_PositionalLight::V3d_PositionalLight const Handle(V3d_Viewer)&  VM,
const V3d_Coordinate  X,
const V3d_Coordinate  Y,
const V3d_Coordinate  Z,
const Quantity_NameOfColor  Color = Quantity_NOC_WHITE,
const Quantity_Coefficient  Attenuation1 = 1.0,
const Quantity_Coefficient  Attenuation2 = 0.0
 

Standard_EXPORT V3d_PositionalLight::V3d_PositionalLight const Handle(V3d_Viewer)&  VM,
const V3d_Coordinate  Xt,
const V3d_Coordinate  Yt,
const V3d_Coordinate  Zt,
const V3d_Coordinate  Xp,
const V3d_Coordinate  Yp,
const V3d_Coordinate  Zp,
const Quantity_NameOfColor  Color = Quantity_NOC_WHITE,
const Quantity_Coefficient  Attenuation1 = 1.0,
const Quantity_Coefficient  Attenuation2 = 0.0
 


Member Function Documentation

Standard_EXPORT void V3d_PositionalLight::Attenuation Quantity_Coefficient &  A1,
Quantity_Coefficient &  A2
const
 

Standard_EXPORT void V3d_PositionalLight::Display const Handle(V3d_View)&  aView,
const V3d_TypeOfRepresentation  Representation
[virtual]
 

Reimplemented from V3d_PositionLight.

Standard_EXPORT const V3d_PositionalLight::Handle Standard_Type   )  const
 

Reimplemented from V3d_PositionLight.

Standard_EXPORT void V3d_PositionalLight::Position V3d_Coordinate X,
V3d_Coordinate Y,
V3d_Coordinate Z
const [virtual]
 

Implements V3d_PositionLight.

Standard_EXPORT void V3d_PositionalLight::SetAttenuation const Quantity_Coefficient  A1,
const Quantity_Coefficient  A2
 

virtual Standard_EXPORT void V3d_PositionalLight::SetPosition const V3d_Coordinate  X,
const V3d_Coordinate  Y,
const V3d_Coordinate  Z
[virtual]
 

Implements V3d_PositionLight.

Standard_EXPORT void V3d_PositionalLight::Symbol const Handle(Graphic3d_Group)&  gsymbol,
const Handle(V3d_View)&  aView
const [private, virtual]
 

Implements V3d_PositionLight.


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:56:25 2008 for OpenCASCADE by  doxygen 1.4.1