Open CASCADE Technology  7.2.0
Public Member Functions

V3d_DirectionalLight Class Reference

Directional light source for a viewer. More...

#include <V3d_DirectionalLight.hxx>

Inheritance diagram for V3d_DirectionalLight:
Inheritance graph
[legend]

Public Member Functions

 V3d_DirectionalLight (const Handle< V3d_Viewer > &theViewer, const V3d_TypeOfOrientation theDirection=V3d_XposYposZpos, const Quantity_Color &theColor=Quantity_NOC_WHITE, const Standard_Boolean theIsHeadlight=Standard_False)
 Creates a directional light source in the viewer. More...
 
 V3d_DirectionalLight (const Handle< V3d_Viewer > &theViewer, const Standard_Real theXt, const Standard_Real theYt, const Standard_Real theZt, const Standard_Real theXp, const Standard_Real theYp, const Standard_Real theZp, const Quantity_Color &theColor=Quantity_NOC_WHITE, const Standard_Boolean theIsHeadlight=Standard_False)
 Creates a directional light source in the viewer. theXt, theYt, theZt : Coordinate of light source Target. theXp, theYp, theZp : Coordinate of light source Position. The others parameters describe before. More...
 
void SetDirection (const V3d_TypeOfOrientation theDirection)
 Defines the direction of the light source by a predefined orientation. More...
 
void SetDirection (const Standard_Real theXm, const Standard_Real theYm, const Standard_Real theZm)
 Defines the direction of the light source by the predefined vector theXm, theYm, theZm. Warning: raises BadValue from V3d if the vector is null. More...
 
void SetDisplayPosition (const Standard_Real theX, const Standard_Real theY, const Standard_Real theZ)
 Defines the point of light source representation. More...
 
virtual void SetPosition (const Standard_Real theXp, const Standard_Real theYp, const Standard_Real theZp) override
 Calls SetDisplayPosition method. More...
 
void SetSmoothAngle (const Standard_Real theValue)
 Modifies the smoothing angle (in radians) More...
 
void Display (const Handle< V3d_View > &theView, const V3d_TypeOfRepresentation theRepresentation) override
 Display the graphic structure of light source in the chosen view. We have three type of representation. More...
 
virtual void Position (Standard_Real &theX, Standard_Real &theY, Standard_Real &theZ) const override
 Calls DisplayPosition method. More...
 
void DisplayPosition (Standard_Real &theX, Standard_Real &theY, Standard_Real &theZ) const
 Returns the chosen position to represent the light source. More...
 
void Direction (Standard_Real &theVx, Standard_Real &theVy, Standard_Real &theVz) const
 Returns the theVx, theVy, theVz direction of the light source. More...
 
- Public Member Functions inherited from V3d_PositionLight
void SetTarget (const Standard_Real theX, const Standard_Real theY, const Standard_Real theZ)
 Defines the target of the light (the center of the sphere). More...
 
void SetRadius (const Standard_Real theRadius)
 Define the radius. More...
 
void OnHideFace (const Handle< V3d_View > &theView)
 Calculate the position of the light, on the hide face of the picking sphere. More...
 
void OnSeeFace (const Handle< V3d_View > &theView)
 Calculate the position of the light, on the seen face of the picking sphere. More...
 
void Tracking (const Handle< V3d_View > &theView, const V3d_TypeOfPickLight theWathPick, const Standard_Integer theXpix, const Standard_Integer theYpix)
 Tracking the light position, or the light space, or the radius of the light space, that depends of initial picking "theWhatPick" (see the pick method). If theWhatPick is SPACELIGHT, then the parameters theXpix, theYpix are the coordinates of a translation vector. More...
 
void Erase ()
 Erase the graphic structure of light source. More...
 
Standard_Real Radius () const
 Returns the radius of the picking sphere. More...
 
Standard_Boolean SeeOrHide (const Handle< V3d_View > &theView) const
 Returns the visibility status If True the source is visible. If False it's hidden. More...
 
void Target (Standard_Real &theX, Standard_Real &theY, Standard_Real &theZ) const
 Returns the position of the target of the light source. More...
 
- Public Member Functions inherited from V3d_Light
void SetColor (const Quantity_Color &theColor)
 Defines the color of a light source by giving the basic color. More...
 
Quantity_Color Color () const
 Returns the color 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...
 
void SetIntensity (const Standard_Real theValue)
 Modifies the intensity of light source. More...
 
Standard_Real Intensity () const
 returns the intensity of light source More...
 
Standard_Real Smoothness () const
 returns the smoothness of light source More...
 
Standard_Boolean IsDisplayed () const
 Returns TRUE when a light representation is displayed. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 opencascade::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...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from V3d_PositionLight
 V3d_PositionLight (const Handle< V3d_Viewer > &theViewer)
 
- Protected Member Functions inherited from V3d_Light
 V3d_Light (const Handle< V3d_Viewer > &theViewer)
 
void SetType (const V3d_TypeOfLight theType)
 Sets type of the light. More...
 
const Graphic3d_CLightLight () const
 Return light properties associated to this light source. Hidden method exposed only to V3d_View. More...
 
- 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 Standard_Real Radius, Standard_Real &X, Standard_Real &Y, Standard_Real &Z, Standard_Real &VX, Standard_Real &VY, Standard_Real &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 inherited from V3d_PositionLight
Graphic3d_Vertex myTarget
 
V3d_TypeOfRepresentation myTypeOfRepresentation
 
- Protected Attributes inherited from V3d_Light
Graphic3d_CLight myLight
 
Handle< Graphic3d_StructuremyGraphicStructure
 
Handle< Graphic3d_StructuremyGraphicStructure1
 

Detailed Description

Directional light source for a viewer.

Constructor & Destructor Documentation

◆ V3d_DirectionalLight() [1/2]

V3d_DirectionalLight::V3d_DirectionalLight ( const Handle< V3d_Viewer > &  theViewer,
const V3d_TypeOfOrientation  theDirection = V3d_XposYposZpos,
const Quantity_Color theColor = Quantity_NOC_WHITE,
const Standard_Boolean  theIsHeadlight = Standard_False 
)

Creates a directional light source in the viewer.

◆ V3d_DirectionalLight() [2/2]

V3d_DirectionalLight::V3d_DirectionalLight ( const Handle< V3d_Viewer > &  theViewer,
const Standard_Real  theXt,
const Standard_Real  theYt,
const Standard_Real  theZt,
const Standard_Real  theXp,
const Standard_Real  theYp,
const Standard_Real  theZp,
const Quantity_Color theColor = Quantity_NOC_WHITE,
const Standard_Boolean  theIsHeadlight = Standard_False 
)

Creates a directional light source in the viewer. theXt, theYt, theZt : Coordinate of light source Target. theXp, theYp, theZp : Coordinate of light source Position. The others parameters describe before.

Member Function Documentation

◆ Direction()

void V3d_DirectionalLight::Direction ( Standard_Real theVx,
Standard_Real theVy,
Standard_Real theVz 
) const

Returns the theVx, theVy, theVz direction of the light source.

◆ Display()

void V3d_DirectionalLight::Display ( const Handle< V3d_View > &  theView,
const V3d_TypeOfRepresentation  theRepresentation 
)
overridevirtual

Display the graphic structure of light source in the chosen 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 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.

◆ DisplayPosition()

void V3d_DirectionalLight::DisplayPosition ( Standard_Real theX,
Standard_Real theY,
Standard_Real theZ 
) const

Returns the chosen position to represent the light source.

◆ Position()

virtual void V3d_DirectionalLight::Position ( Standard_Real theX,
Standard_Real theY,
Standard_Real theZ 
) const
overridevirtual

Calls DisplayPosition method.

Implements V3d_PositionLight.

◆ SetDirection() [1/2]

void V3d_DirectionalLight::SetDirection ( const V3d_TypeOfOrientation  theDirection)

Defines the direction of the light source by a predefined orientation.

◆ SetDirection() [2/2]

void V3d_DirectionalLight::SetDirection ( const Standard_Real  theXm,
const Standard_Real  theYm,
const Standard_Real  theZm 
)

Defines the direction of the light source by the predefined vector theXm, theYm, theZm. Warning: raises BadValue from V3d if the vector is null.

◆ SetDisplayPosition()

void V3d_DirectionalLight::SetDisplayPosition ( const Standard_Real  theX,
const Standard_Real  theY,
const Standard_Real  theZ 
)

Defines the point of light source representation.

◆ SetPosition()

virtual void V3d_DirectionalLight::SetPosition ( const Standard_Real  theXp,
const Standard_Real  theYp,
const Standard_Real  theZp 
)
overridevirtual

Calls SetDisplayPosition method.

Implements V3d_PositionLight.

◆ SetSmoothAngle()

void V3d_DirectionalLight::SetSmoothAngle ( const Standard_Real  theValue)

Modifies the smoothing angle (in radians)


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