V3d_Light Class Reference

Defines services on Light type objects..

#include <V3d_Light.hxx>

Inheritance diagram for V3d_Light:

Public Member Functions
void	SetColor (const Quantity_TypeOfColor Type, const Quantity_Parameter V1, const Quantity_Parameter V2, const Quantity_Parameter V3)
	Defines the colour of a light source according to the type of colour definition and the three corresponding values.
void	SetColor (const Quantity_NameOfColor Name)
	Defines the colour of a light source by giving the name of the colour in the form Quantity_NOC_xxxx .
void	SetColor (const Quantity_Color &Name)
	Defines the colour of a light source by giving the basic colour.
void	Color (const Quantity_TypeOfColor Type, Quantity_Parameter &V1, Quantity_Parameter &V2, Quantity_Parameter &V3) const
	Returns the colour of the light source depending of the color type.
void	Color (Quantity_NameOfColor &Name) const
	Returns the colour of the light source.
Quantity_Color	Color () const
	Returns the colour of the light source.
V3d_TypeOfLight	Type () const
	Returns the Type of the Light
Standard_Boolean	Headlight () const
	returns true if the light is a headlight
Standard_Boolean	IsDisplayed () const
	Returns TRUE when a light representation is displayed
Protected Member Functions
	V3d_Light (const Handle< V3d_Viewer > &VM)
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.
Protected Attributes
V3d_TypeOfLight	MyType
Handle_Visual3d_Light	MyLight
Handle_Graphic3d_Structure	MyGraphicStructure
Handle_Graphic3d_Structure	MyGraphicStructure1
Friends
void	V3d_View::SetLightOn (const Handle< V3d_Light > &MyLight)
	Activates MyLight in the view.
void	V3d_View::SetLightOn ()
	Activates all the lights defined in this view.
void	V3d_View::SetLightOff (const Handle< V3d_Light > &MyLight)
	Desactivate MyLight in this view.
void	V3d_View::SetLightOff ()
	Deactivate all the Lights defined in this view.

---

Constructor & Destructor Documentation

V3d_Light::V3d_Light

(

const Handle< V3d_Viewer > &

VM

)

[protected]

---

Member Function Documentation

void V3d_Light::Color	(	const Quantity_TypeOfColor	Type,
		Quantity_Parameter &	V1,
		Quantity_Parameter &	V2,
		Quantity_Parameter &	V3
	)		const

void V3d_Light::Color

(

Quantity_NameOfColor &

Name

)

const

Quantity_Color V3d_Light::Color

(

)

const

Standard_Boolean V3d_Light::Headlight

(

)

const

Standard_Boolean V3d_Light::IsDisplayed

(

)

const

void V3d_Light::SetColor	(	const Quantity_TypeOfColor	Type,
		const Quantity_Parameter	V1,
		const Quantity_Parameter	V2,
		const Quantity_Parameter	V3
	)

void V3d_Light::SetColor

(

const Quantity_NameOfColor

Name

)

void V3d_Light::SetColor

(

const Quantity_Color &

Name

)

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
	)		[static, protected]

V3d_TypeOfLight V3d_Light::Type

(

)

const

---

Friends And Related Function Documentation

void V3d_View::SetLightOff

(

const Handle< V3d_Light > &

MyLight

)

[friend]

void V3d_View::SetLightOff

(

)

[friend]

void V3d_View::SetLightOn

(

const Handle< V3d_Light > &

MyLight

)

[friend]

void V3d_View::SetLightOn

(

)

[friend]

---

Field Documentation

Handle_Graphic3d_Structure V3d_Light::MyGraphicStructure [protected]

Handle_Graphic3d_Structure V3d_Light::MyGraphicStructure1 [protected]

Handle_Visual3d_Light V3d_Light::MyLight [protected]

V3d_TypeOfLight V3d_Light::MyType [protected]

---

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

• V3d_Light.hxx