Open CASCADE Technology 6.6.0
Public Member Functions | Protected Member Functions | Protected Attributes
V3d_PositionLight Class Reference

Base class for Positional, Spot and Directional Light classes

#include <V3d_PositionLight.hxx>

Inheritance diagram for V3d_PositionLight:
Inheritance graph
[legend]

Public Member Functions

virtual void SetPosition (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z)=0
 Defines the position of the light source. Should be redefined!

void SetTarget (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z)
 Defines the target of the light (the center
of the sphere)

void SetRadius (const Quantity_Parameter Radius)
 Define the radius.

void OnHideFace (const Handle< V3d_View > &aView)
 Calculate the position of the light, on the hide face
of the picking sphere.

void OnSeeFace (const Handle< V3d_View > &aView)
 Calculate the position of the light, on the seen face
of the picking sphere.

void Tracking (const Handle< V3d_View > &aView, const V3d_TypeOfPickLight WathPick, const Standard_Integer Xpix, const Standard_Integer Ypix)
 Tracking the light position, or the light space,
or the radius of the light space, that depends of
initial picking "WhatPick" (see the pick method).
If WhatPick is SPACELIGHT, then the parameters
Xpix, Ypix are the coordinates of a translation vector.

virtual void Display (const Handle< V3d_View > &aView, const V3d_TypeOfRepresentation Representation=V3d_SIMPLE)
 Display the graphic structure of light source
in the choosen view. We have three type of representation

void Erase ()
 Erase the graphic structure of light source.

Quantity_Parameter Radius () const
 Returns the radius of the picking sphere.

Standard_Boolean SeeOrHide (const Handle< V3d_View > &aView) const
 Returns the visibility status
If True the source is visible.
If False it's hidden.

virtual void Position (V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z) const =0
 Returns the position of the light source.

void Target (V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z) const
 Returns the position of the target of the light source.

Protected Member Functions

 V3d_PositionLight (const Handle< V3d_Viewer > &VM)

Protected Attributes

Graphic3d_Vertex MyTarget
V3d_TypeOfRepresentation MyTypeOfRepresentation

Constructor & Destructor Documentation

V3d_PositionLight::V3d_PositionLight ( const Handle< V3d_Viewer > &  VM) [protected]

Member Function Documentation

virtual void V3d_PositionLight::Display ( const Handle< V3d_View > &  aView,
const V3d_TypeOfRepresentation  Representation = V3d_SIMPLE 
) [virtual]
  • 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.

Reimplemented in V3d_PositionalLight, V3d_DirectionalLight, and V3d_SpotLight.

void V3d_PositionLight::Erase ( )
void V3d_PositionLight::OnHideFace ( const Handle< V3d_View > &  aView)
void V3d_PositionLight::OnSeeFace ( const Handle< V3d_View > &  aView)
virtual void V3d_PositionLight::Position ( V3d_Coordinate X,
V3d_Coordinate Y,
V3d_Coordinate Z 
) const [pure virtual]
Quantity_Parameter V3d_PositionLight::Radius ( ) const
Standard_Boolean V3d_PositionLight::SeeOrHide ( const Handle< V3d_View > &  aView) const
virtual void V3d_PositionLight::SetPosition ( const V3d_Coordinate  X,
const V3d_Coordinate  Y,
const V3d_Coordinate  Z 
) [pure virtual]
void V3d_PositionLight::SetRadius ( const Quantity_Parameter  Radius)
void V3d_PositionLight::SetTarget ( const V3d_Coordinate  X,
const V3d_Coordinate  Y,
const V3d_Coordinate  Z 
)
void V3d_PositionLight::Target ( V3d_Coordinate X,
V3d_Coordinate Y,
V3d_Coordinate Z 
) const
void V3d_PositionLight::Tracking ( const Handle< V3d_View > &  aView,
const V3d_TypeOfPickLight  WathPick,
const Standard_Integer  Xpix,
const Standard_Integer  Ypix 
)

Field Documentation


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines