Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
V3d_DirectionalLight Class Reference

Create and modify a directional light source
in a viewer.

#include <V3d_DirectionalLight.hxx>

Inheritance diagram for V3d_DirectionalLight:
Inheritance graph
[legend]

Public Member Functions

 V3d_DirectionalLight (const Handle< V3d_Viewer > &VM, const V3d_TypeOfOrientation Direction=V3d_XposYposZpos, const Quantity_NameOfColor Color=Quantity_NOC_WHITE, const Standard_Boolean Headlight=Standard_False)
 Creates a directional light source in the viewer.

 V3d_DirectionalLight (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 Standard_Boolean Headlight=Standard_False)
 Creates a directional light source in the viewer.
Xt,Yt,Zt : Coordinate of light source Target.
Xp,Yp,Zp : Coordinate of light source Position.
The others parameters describe before.

void SetDirection (const V3d_TypeOfOrientation Direction)
 Defines the direction of the light source
by a predefined orientation.

void SetDirection (const Quantity_Parameter Xm, const Quantity_Parameter Ym, const Quantity_Parameter Zm)
 Defines the direction of the light source by the predefined
vector Xm,Ym,Zm.
Warning: raises BadValue from Viewer if the vector is null.

void SetDisplayPosition (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z)
 Defines the point of light source representation.

virtual void SetPosition (const V3d_Coordinate Xp, const V3d_Coordinate Yp, const V3d_Coordinate Zp)
 Calls SetDisplayPosition method.

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

virtual void Position (V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z) const
 Calls DisplayPosition method.

void DisplayPosition (V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z) const
 Returns the choosen position to represent the light
source.

void Direction (Quantity_Parameter &Vx, Quantity_Parameter &Vy, Quantity_Parameter &Vz) const
 Returns the Vx,Vy,Vz direction of the light source.


Constructor & Destructor Documentation


Member Function Documentation

void V3d_DirectionalLight::Display ( const Handle< V3d_View > &  aView,
const V3d_TypeOfRepresentation  Representation 
) [virtual]
  • SIMPLE : Only the light source is displayed.
  • PARTIAL : The light source and the light space are
    displayed.
  • COMPLETE : The same representation as PARTIAL.
    We can choose the "SAMELAST" as parameter of representation
    In this case the graphic structure representation will be
    the last displayed.

Reimplemented from V3d_PositionLight.

virtual void V3d_DirectionalLight::Position ( V3d_Coordinate X,
V3d_Coordinate Y,
V3d_Coordinate Z 
) const [virtual]

Implements V3d_PositionLight.

Implements V3d_PositionLight.


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