Defines services on Light type objects..
More...

#include <V3d_Light.hxx>

Inheritance diagram for V3d_Light:

[legend]

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. More...

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 . More...

void	SetColor (const Quantity_Color &Name)
	Defines the colour of a light source by giving the basic colour. More...

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. More...

void	Color (Quantity_NameOfColor &Name) const
	Returns the colour of the light source. More...

Quantity_Color	Color () const
	Returns the colour 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...

Standard_Boolean	IsDisplayed () const
	Returns TRUE when a light representation is displayed More...

Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const
	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_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const 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 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...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

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. More...

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. More...

void	V3d_View::SetLightOn ()
	Activates all the lights defined in this view. More...

void	V3d_View::SetLightOff (const Handle< V3d_Light > &MyLight)
	Desactivate MyLight in this view. More...

void	V3d_View::SetLightOff ()
	Deactivate all the Lights defined in this view. More...

Detailed Description

Defines services on Light type objects..

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

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

void V3d_Light::Color ( Quantity_NameOfColor & Name ) const

Returns the colour of the light source.

Quantity_Color V3d_Light::Color ( ) const

Returns the colour of the light source.

Standard_Boolean V3d_Light::Headlight ( ) const

returns true if the light is a headlight

Standard_Boolean V3d_Light::IsDisplayed ( ) const

Returns TRUE when a light representation is displayed

void V3d_Light::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 V3d_Light::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 V3d_Light::SetColor ( const Quantity_Color & Name )

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

void V3d_Light::SetHeadlight ( const Standard_Boolean theValue )

Setup headlight flag.

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::SetLightOff ( const Handle< V3d_Light > & MyLight )

friend

Desactivate MyLight in this view.

void V3d_View::SetLightOff ( )

friend

Deactivate all the Lights defined in this view.

void V3d_View::SetLightOn ( const Handle< V3d_Light > & MyLight )

friend

Activates MyLight in the view.

void V3d_View::SetLightOn ( )

friend

Activates all the lights defined in this view.

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation