VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkExternalLight Class Reference

a virtual light object for tweaking existing lights in an external 3D rendering context More...

#include <vtkExternalLight.h>

Inheritance diagram for vtkExternalLight:
[legend]
Collaboration diagram for vtkExternalLight:
[legend]

Public Types

enum  ReplaceModes { INDIVIDUAL_PARAMS = 0, ALL_PARAMS = 1 }
 
typedef vtkLight Superclass
 
- Public Types inherited from vtkLight
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkExternalLightNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetLightIndex (int)
 Set/Get light index This should be the OpenGL light identifier. More...
 
virtual int GetLightIndex ()
 
virtual void SetReplaceMode (int)
 Set/Get replace mode This determines how this ExternalLight will be used to tweak parameters on an existing light in the rendering context. More...
 
virtual int GetReplaceMode ()
 
void SetPosition (double, double, double) override
 Override Set method to keep a record of changed value. More...
 
void SetFocalPoint (double, double, double) override
 Override Set method to keep a record of changed value. More...
 
void SetAmbientColor (double, double, double) override
 Override Set method to keep a record of changed value. More...
 
void SetDiffuseColor (double, double, double) override
 Override Set method to keep a record of changed value. More...
 
void SetSpecularColor (double, double, double) override
 Override Set method to keep a record of changed value. More...
 
void SetIntensity (double) override
 Override Set method to keep a record of changed value. More...
 
void SetConeAngle (double) override
 Override Set method to keep a record of changed value. More...
 
void SetAttenuationValues (double, double, double) override
 Override Set method to keep a record of changed value. More...
 
void SetExponent (double) override
 Override Set method to keep a record of changed value. More...
 
void SetPositional (vtkTypeBool) override
 Override Set method to keep a record of changed value. More...
 
virtual bool GetPositionSet ()
 Check whether value set by user. More...
 
virtual bool GetFocalPointSet ()
 Check whether value set by user. More...
 
virtual bool GetAmbientColorSet ()
 Check whether value set by user. More...
 
virtual bool GetDiffuseColorSet ()
 Check whether value set by user. More...
 
virtual bool GetSpecularColorSet ()
 Check whether value set by user. More...
 
virtual bool GetIntensitySet ()
 Check whether value set by user. More...
 
virtual bool GetConeAngleSet ()
 Check whether value set by user. More...
 
virtual bool GetAttenuationValuesSet ()
 Check whether value set by user. More...
 
virtual bool GetExponentSet ()
 Check whether value set by user. More...
 
virtual bool GetPositionalSet ()
 Check whether value set by user. More...
 
- Public Member Functions inherited from vtkLight
vtkLightNewInstance () const
 
virtual vtkLightShallowClone ()
 Create a new light object with the same light parameters than the current object (any ivar from the superclasses (vtkObject and vtkObjectBase), like reference counting, timestamp and observers are not copied). More...
 
virtual void Render (vtkRenderer *, int)
 Abstract interface to renderer. More...
 
virtual void SetAmbientColor (double[3])
 
virtual doubleGetAmbientColor ()
 
virtual void GetAmbientColor (double data[3])
 
virtual void SetDiffuseColor (double[3])
 
virtual doubleGetDiffuseColor ()
 
virtual void GetDiffuseColor (double data[3])
 
virtual void SetSpecularColor (double[3])
 
virtual doubleGetSpecularColor ()
 
virtual void GetSpecularColor (double data[3])
 
void SetColor (double, double, double)
 
void SetColor (const double a[3])
 
virtual void SetPosition (double[3])
 
virtual doubleGetPosition ()
 
virtual void GetPosition (double data[3])
 
void SetPosition (const float *a)
 
virtual void SetFocalPoint (double[3])
 
virtual doubleGetFocalPoint ()
 
virtual void GetFocalPoint (double data[3])
 
void SetFocalPoint (const float *a)
 
virtual double GetIntensity ()
 
virtual void SetSwitch (vtkTypeBool)
 Turn the light on or off. More...
 
virtual vtkTypeBool GetSwitch ()
 
virtual void SwitchOn ()
 
virtual void SwitchOff ()
 
virtual vtkTypeBool GetPositional ()
 
virtual void PositionalOn ()
 
virtual void PositionalOff ()
 
virtual double GetExponent ()
 
virtual double GetConeAngle ()
 
virtual void SetAttenuationValues (double[3])
 
virtual doubleGetAttenuationValues ()
 
virtual void GetAttenuationValues (double data[3])
 
virtual void SetTransformMatrix (vtkMatrix4x4 *)
 Set/Get the light's transformation matrix. More...
 
virtual vtkMatrix4x4GetTransformMatrix ()
 
void GetTransformedPosition (double &a0, double &a1, double &a2)
 Get the position of the light, modified by the transformation matrix (if it exists). More...
 
void GetTransformedPosition (double a[3])
 
doubleGetTransformedPosition ()
 
void GetTransformedFocalPoint (double &a0, double &a1, double &a2)
 Get the focal point of the light, modified by the transformation matrix (if it exists). More...
 
void GetTransformedFocalPoint (double a[3])
 
doubleGetTransformedFocalPoint ()
 
void SetDirectionAngle (double elevation, double azimuth)
 Set the position and focal point of a light based on elevation and azimuth. More...
 
void SetDirectionAngle (const double ang[2])
 
void DeepCopy (vtkLight *light)
 Perform deep copy of this light. More...
 
virtual void SetLightType (int)
 Set/Get the type of the light. More...
 
virtual int GetLightType ()
 
void SetLightTypeToHeadlight ()
 
void SetLightTypeToSceneLight ()
 
void SetLightTypeToCameraLight ()
 
int LightTypeIsHeadlight ()
 Query the type of the light. More...
 
int LightTypeIsSceneLight ()
 
int LightTypeIsCameraLight ()
 
virtual void SetShadowAttenuation (float)
 Set/Get the shadow intensity By default a light will be completely blocked when in shadow by setting this value to less than 1.0 you can control how much light is attenuated when in shadow. More...
 
virtual float GetShadowAttenuation ()
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with the light. More...
 
virtual void SetInformation (vtkInformation *)
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExternalLightSafeDownCast (vtkObjectBase *o)
 
static vtkExternalLightNew ()
 Create an external light object with the focal point at the origin and its position set to (0,0,1). More...
 
- Static Public Member Functions inherited from vtkLight
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLightSafeDownCast (vtkObjectBase *o)
 
static vtkLightNew ()
 Create a light with the focal point at the origin and its position set to (0,0,1). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkExternalLight ()
 
 ~vtkExternalLight () override
 
- Protected Member Functions inherited from vtkLight
 vtkLight ()
 
 ~vtkLight () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int LightIndex
 
int ReplaceMode
 
bool PositionSet
 
bool FocalPointSet
 
bool AmbientColorSet
 
bool DiffuseColorSet
 
bool SpecularColorSet
 
bool IntensitySet
 
bool ConeAngleSet
 
bool AttenuationValuesSet
 
bool ExponentSet
 
bool PositionalSet
 
- Protected Attributes inherited from vtkLight
double FocalPoint [3]
 
double Position [3]
 
double Intensity
 
double AmbientColor [3]
 
double DiffuseColor [3]
 
double SpecularColor [3]
 
vtkTypeBool Switch
 
vtkTypeBool Positional
 
double Exponent
 
double ConeAngle
 
double AttenuationValues [3]
 
vtkMatrix4x4TransformMatrix
 
double TransformedFocalPointReturn [3]
 
double TransformedPositionReturn [3]
 
int LightType
 
float ShadowAttenuation
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a virtual light object for tweaking existing lights in an external 3D rendering context

vtkExternalLight is a virtual light object for tweaking existing lights in an external 3D rendering context. It provides a mechanism to adjust and control parameters of existing lights in an external OpenGL context.

It provides methods to locate and point the light, and set its brightness and color. In addition to the basic infinite distance point light source attributes, you can also specify the light attenuation values and cone angle. These attributes are only used if the light is a positional light.

By default, vtkExternalLight overrides specific light parameters as set by the user. Setting the ReplaceMode to ALL_PARAMS, will set all the light parameter values to the ones set in vtkExternalLight.

Warning
Use the vtkExternalLight object to tweak parameters of lights created in the external context. This class does NOT create new lights in the scene.
Example:
Usage example for vtkExternalLight in conjunction with vtkExternalOpenGLRenderer and ExternalVTKWidget
exLight->SetLightIndex(GL_LIGHT0); // GL_LIGHT0 identifies the external light
exLight->SetDiffuseColor(1.0, 0.0, 0.0); // Changing diffuse color
ren->AddExternalLight(exLight.GetPointer());
See also
vtkExternalOpenGLRenderer ExternalVTKWidget

Definition at line 61 of file vtkExternalLight.h.

Member Typedef Documentation

◆ Superclass

Definition at line 64 of file vtkExternalLight.h.

Member Enumeration Documentation

◆ ReplaceModes

Enumerator
INDIVIDUAL_PARAMS 
ALL_PARAMS 

Definition at line 78 of file vtkExternalLight.h.

Constructor & Destructor Documentation

◆ vtkExternalLight()

vtkExternalLight::vtkExternalLight ( )
protected

◆ ~vtkExternalLight()

vtkExternalLight::~vtkExternalLight ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkExternalLight::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkExternalLight::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkLight.

◆ SafeDownCast()

static vtkExternalLight* vtkExternalLight::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkExternalLight::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkLight.

◆ NewInstance()

vtkExternalLight* vtkExternalLight::NewInstance ( ) const

◆ PrintSelf()

void vtkExternalLight::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkLight.

◆ New()

static vtkExternalLight* vtkExternalLight::New ( )
static

Create an external light object with the focal point at the origin and its position set to (0,0,1).

The light is a Headlight, its color is white (black ambient, white diffuse, white specular), intensity=1, the light is turned on, positional lighting is off, ConeAngle=30, AttenuationValues=(1,0,0), Exponent=1 and the TransformMatrix is NULL. The light index is GL_LIGHT0, which means the existing light with index GL_LIGHT0 will be affected by this light.

◆ SetLightIndex()

virtual void vtkExternalLight::SetLightIndex ( int  )
virtual

Set/Get light index This should be the OpenGL light identifier.

(e.g.: GL_LIGHT0) (Default: GL_LIGHT0)

◆ GetLightIndex()

virtual int vtkExternalLight::GetLightIndex ( )
virtual

◆ SetReplaceMode()

virtual void vtkExternalLight::SetReplaceMode ( int  )
virtual

Set/Get replace mode This determines how this ExternalLight will be used to tweak parameters on an existing light in the rendering context.

(Default: INDIVIDUAL_PARAMS)

◆ GetReplaceMode()

virtual int vtkExternalLight::GetReplaceMode ( )
virtual

◆ SetPosition()

void vtkExternalLight::SetPosition ( double  ,
double  ,
double   
)
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ SetFocalPoint()

void vtkExternalLight::SetFocalPoint ( double  ,
double  ,
double   
)
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ SetAmbientColor()

void vtkExternalLight::SetAmbientColor ( double  ,
double  ,
double   
)
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ SetDiffuseColor()

void vtkExternalLight::SetDiffuseColor ( double  ,
double  ,
double   
)
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ SetSpecularColor()

void vtkExternalLight::SetSpecularColor ( double  ,
double  ,
double   
)
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ SetIntensity()

void vtkExternalLight::SetIntensity ( double  )
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ SetConeAngle()

void vtkExternalLight::SetConeAngle ( double  )
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ SetAttenuationValues()

void vtkExternalLight::SetAttenuationValues ( double  ,
double  ,
double   
)
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ SetExponent()

void vtkExternalLight::SetExponent ( double  )
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ SetPositional()

void vtkExternalLight::SetPositional ( vtkTypeBool  )
overridevirtual

Override Set method to keep a record of changed value.

Reimplemented from vtkLight.

◆ GetPositionSet()

virtual bool vtkExternalLight::GetPositionSet ( )
virtual

Check whether value set by user.

◆ GetFocalPointSet()

virtual bool vtkExternalLight::GetFocalPointSet ( )
virtual

Check whether value set by user.

◆ GetAmbientColorSet()

virtual bool vtkExternalLight::GetAmbientColorSet ( )
virtual

Check whether value set by user.

◆ GetDiffuseColorSet()

virtual bool vtkExternalLight::GetDiffuseColorSet ( )
virtual

Check whether value set by user.

◆ GetSpecularColorSet()

virtual bool vtkExternalLight::GetSpecularColorSet ( )
virtual

Check whether value set by user.

◆ GetIntensitySet()

virtual bool vtkExternalLight::GetIntensitySet ( )
virtual

Check whether value set by user.

◆ GetConeAngleSet()

virtual bool vtkExternalLight::GetConeAngleSet ( )
virtual

Check whether value set by user.

◆ GetAttenuationValuesSet()

virtual bool vtkExternalLight::GetAttenuationValuesSet ( )
virtual

Check whether value set by user.

◆ GetExponentSet()

virtual bool vtkExternalLight::GetExponentSet ( )
virtual

Check whether value set by user.

◆ GetPositionalSet()

virtual bool vtkExternalLight::GetPositionalSet ( )
virtual

Check whether value set by user.

Member Data Documentation

◆ LightIndex

int vtkExternalLight::LightIndex
protected

Definition at line 242 of file vtkExternalLight.h.

◆ ReplaceMode

int vtkExternalLight::ReplaceMode
protected

Definition at line 243 of file vtkExternalLight.h.

◆ PositionSet

bool vtkExternalLight::PositionSet
protected

Definition at line 245 of file vtkExternalLight.h.

◆ FocalPointSet

bool vtkExternalLight::FocalPointSet
protected

Definition at line 246 of file vtkExternalLight.h.

◆ AmbientColorSet

bool vtkExternalLight::AmbientColorSet
protected

Definition at line 247 of file vtkExternalLight.h.

◆ DiffuseColorSet

bool vtkExternalLight::DiffuseColorSet
protected

Definition at line 248 of file vtkExternalLight.h.

◆ SpecularColorSet

bool vtkExternalLight::SpecularColorSet
protected

Definition at line 249 of file vtkExternalLight.h.

◆ IntensitySet

bool vtkExternalLight::IntensitySet
protected

Definition at line 250 of file vtkExternalLight.h.

◆ ConeAngleSet

bool vtkExternalLight::ConeAngleSet
protected

Definition at line 251 of file vtkExternalLight.h.

◆ AttenuationValuesSet

bool vtkExternalLight::AttenuationValuesSet
protected

Definition at line 252 of file vtkExternalLight.h.

◆ ExponentSet

bool vtkExternalLight::ExponentSet
protected

Definition at line 253 of file vtkExternalLight.h.

◆ PositionalSet

bool vtkExternalLight::PositionalSet
protected

Definition at line 254 of file vtkExternalLight.h.


The documentation for this class was generated from the following file:
vtkNew::GetPointer
T * GetPointer() const noexcept
Get a raw pointer to the contained object.
Definition: vtkNew.h:153
vtkExternalOpenGLRenderer
OpenGL renderer.
Definition: vtkExternalOpenGLRenderer.h:43
vtkExternalOpenGLRenderer::SafeDownCast
static vtkExternalOpenGLRenderer * SafeDownCast(vtkObjectBase *o)
vtkNew
Allocate and hold a VTK object.
Definition: vtkMeta.h:29
ExternalVTKWidget::AddRenderer
vtkExternalOpenGLRenderer * AddRenderer()
vtkExternalLight::SetDiffuseColor
void SetDiffuseColor(double, double, double) override
Override Set method to keep a record of changed value.
vtkExternalOpenGLRenderer::AddExternalLight
virtual void AddExternalLight(vtkExternalLight *)
Add an external light to the list of external lights.
vtkExternalLight::SetLightIndex
virtual void SetLightIndex(int)
Set/Get light index This should be the OpenGL light identifier.