Base class for Positional, Spot and Directional Light classes
More...

#include <V3d_PositionLight.hxx>

Inheritance diagram for V3d_PositionLight:

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

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

void	SetRadius (const Quantity_Parameter Radius)
	Define the radius. More...

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from V3d_Light
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_PositionLight (const Handle< V3d_Viewer > &VM)

Protected Member Functions inherited from V3d_Light
	V3d_Light (const Handle< V3d_Viewer > &VM)

Protected Attributes
Graphic3d_Vertex	MyTarget

V3d_TypeOfRepresentation	MyTypeOfRepresentation

Protected Attributes inherited from V3d_Light
V3d_TypeOfLight	MyType

Handle_Visual3d_Light	MyLight

Handle_Graphic3d_Structure	MyGraphicStructure

Handle_Graphic3d_Structure	MyGraphicStructure1

Additional Inherited Members
Static Protected Member Functions inherited from V3d_Light
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...

Detailed Description

Base class for Positional, Spot and Directional Light classes

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

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.

Reimplemented in V3d_SpotLight, V3d_PositionalLight, and V3d_DirectionalLight.

void V3d_PositionLight::Erase ( )

Erase the graphic structure of light source.

void V3d_PositionLight::OnHideFace ( const Handle< V3d_View > & aView )

Calculate the position of the light, on the hide face
of the picking sphere.

void V3d_PositionLight::OnSeeFace ( const Handle< V3d_View > & aView )

Calculate the position of the light, on the seen face
of the picking sphere.

virtual void V3d_PositionLight::Position	(	V3d_Coordinate &	X,
		V3d_Coordinate &	Y,
		V3d_Coordinate &	Z
	)		const

pure virtual

Returns the position of the light source.

Implemented in V3d_SpotLight, V3d_PositionalLight, and V3d_DirectionalLight.

Quantity_Parameter V3d_PositionLight::Radius ( ) const

Returns the radius of the picking sphere.

Standard_Boolean V3d_PositionLight::SeeOrHide ( const Handle< V3d_View > & aView ) const

Returns the visibility status
If True the source is visible.
If False it's hidden.

virtual void V3d_PositionLight::SetPosition	(	const V3d_Coordinate	X,
		const V3d_Coordinate	Y,
		const V3d_Coordinate	Z
	)

pure virtual

Defines the position of the light source. Should be redefined!

Implemented in V3d_SpotLight, V3d_DirectionalLight, and V3d_PositionalLight.

void V3d_PositionLight::SetRadius ( const Quantity_Parameter Radius )

Define the radius.

void V3d_PositionLight::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 V3d_PositionLight::Target	(	V3d_Coordinate &	X,
		V3d_Coordinate &	Y,
		V3d_Coordinate &	Z
	)		const

Returns the position of the target of the light source.

void V3d_PositionLight::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.

Field Documentation

Graphic3d_Vertex V3d_PositionLight::MyTarget

protected

V3d_TypeOfRepresentation V3d_PositionLight::MyTypeOfRepresentation

protected

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

V3d_PositionLight.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation