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

#include <vtkExternalLight.h>

Inheritance diagram for vtkExternalLight:

Collaboration diagram for vtkExternalLight:

Public Types
enum	ReplaceModes { INDIVIDUAL_PARAMS = 0, ALL_PARAMS = 1 }

typedef vtkLight	Superclass

Public Types inherited from vtkLight
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkExternalLight *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetPosition (double, double, double)

void	SetFocalPoint (double, double, double)

void	SetAmbientColor (double, double, double)

void	SetDiffuseColor (double, double, double)

void	SetSpecularColor (double, double, double)

void	SetIntensity (double)

void	SetConeAngle (double)

void	SetAttenuationValues (double, double, double)

void	SetExponent (double)

void	SetPositional (int)


virtual void	SetLightIndex (int)

virtual int	GetLightIndex ()


virtual void	SetReplaceMode (int)

virtual int	GetReplaceMode ()


virtual bool	GetPositionSet ()


virtual bool	GetFocalPointSet ()


virtual bool	GetAmbientColorSet ()


virtual bool	GetDiffuseColorSet ()


virtual bool	GetSpecularColorSet ()


virtual bool	GetIntensitySet ()


virtual bool	GetConeAngleSet ()


virtual bool	GetAttenuationValuesSet ()


virtual bool	GetExponentSet ()


virtual bool	GetPositionalSet ()

Public Member Functions inherited from vtkLight
vtkLight *	NewInstance () const

virtual vtkLight *	ShallowClone ()

virtual void	Render (vtkRenderer *, int)

void	DeepCopy (vtkLight *light)

void	ReadSelf (istream &is)

void	WriteSelf (ostream &os)

virtual void	SetAmbientColor (double[3])

virtual double *	GetAmbientColor ()

virtual void	GetAmbientColor (double data[3])

virtual void	SetDiffuseColor (double[3])

virtual double *	GetDiffuseColor ()

virtual void	GetDiffuseColor (double data[3])

virtual void	SetSpecularColor (double[3])

virtual double *	GetSpecularColor ()

virtual void	GetSpecularColor (double data[3])

void	SetColor (double, double, double)

void	SetColor (const double a[3])

virtual void	SetPosition (double[3])

virtual double *	GetPosition ()

virtual void	GetPosition (double data[3])

void	SetPosition (const float *a)

virtual void	SetFocalPoint (double[3])

virtual double *	GetFocalPoint ()

virtual void	GetFocalPoint (double data[3])

void	SetFocalPoint (const float *a)

virtual double	GetIntensity ()

virtual void	SetSwitch (int)

virtual int	GetSwitch ()

virtual void	SwitchOn ()

virtual void	SwitchOff ()

virtual int	GetPositional ()

virtual void	PositionalOn ()

virtual void	PositionalOff ()

virtual double	GetExponent ()

virtual double	GetConeAngle ()

virtual void	SetAttenuationValues (double[3])

virtual double *	GetAttenuationValues ()

virtual void	GetAttenuationValues (double data[3])

virtual void	SetTransformMatrix (vtkMatrix4x4 *)

virtual vtkMatrix4x4 *	GetTransformMatrix ()

void	GetTransformedPosition (double &a0, double &a1, double &a2)

void	GetTransformedPosition (double a[3])

double *	GetTransformedPosition ()

void	GetTransformedFocalPoint (double &a0, double &a1, double &a2)

void	GetTransformedFocalPoint (double a[3])

double *	GetTransformedFocalPoint ()

void	SetDirectionAngle (double elevation, double azimuth)

void	SetDirectionAngle (const double ang[2])

virtual void	SetLightType (int)

virtual int	GetLightType ()

void	SetLightTypeToHeadlight ()

void	SetLightTypeToSceneLight ()

void	SetLightTypeToCameraLight ()

int	LightTypeIsHeadlight ()

int	LightTypeIsSceneLight ()

int	LightTypeIsCameraLight ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkExternalLight *	SafeDownCast (vtkObjectBase *o)

static vtkExternalLight *	New ()

Static Public Member Functions inherited from vtkLight
static int	IsTypeOf (const char *type)

static vtkLight *	SafeDownCast (vtkObjectBase *o)

static vtkLight *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkExternalLight ()

	~vtkExternalLight ()

Protected Member Functions inherited from vtkLight
	vtkLight ()

	~vtkLight ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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]

int	Switch

int	Positional

double	Exponent

double	ConeAngle

double	AttenuationValues [3]

vtkMatrix4x4 *	TransformMatrix

double	TransformedFocalPointReturn [3]

double	TransformedPositionReturn [3]

int	LightType

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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
vtkNew<vtkExternalLight> exLight;

exLight->SetLightIndex(GL_LIGHT0); // GL_LIGHT0 identifies the external light

exLight->SetDiffuseColor(1.0, 0.0, 0.0); // Changing diffuse color

vtkNew<ExternalVTKWidget> exWidget;

vtkExternalOpenGLRenderer* ren = vtkExternalOpenGLRenderer::SafeDownCast(exWidget->AddRenderer());

ren->AddExternalLight(exLight.GetPointer());

See also: vtkExternalOpenGLRenderer ExternalVTKWidget

Definition at line 60 of file vtkExternalLight.h.

Member Typedef Documentation

typedef vtkLight vtkExternalLight::Superclass

Definition at line 63 of file vtkExternalLight.h.

Member Enumeration Documentation

enum vtkExternalLight::ReplaceModes

Enumerator
INDIVIDUAL_PARAMS
ALL_PARAMS

Definition at line 75 of file vtkExternalLight.h.

Constructor & Destructor Documentation

vtkExternalLight::vtkExternalLight ( )

protected

vtkExternalLight::~vtkExternalLight ( )

protected

Member Function Documentation

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

static

virtual int 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.

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

static

virtual vtkObjectBase* vtkExternalLight::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkLight.

vtkExternalLight* vtkExternalLight::NewInstance ( ) const

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

virtual

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.

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.

virtual void vtkExternalLight::SetLightIndex ( int )

virtual

Set/Get light index This should be the OpenGL light identifier. (e.g.: GL_LIGHT0) (Default: GL_LIGHT0)

virtual int vtkExternalLight::GetLightIndex ( )

virtual

Set/Get light index This should be the OpenGL light identifier. (e.g.: GL_LIGHT0) (Default: GL_LIGHT0)

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)

vtkExternalLight::INDIVIDUAL_PARAMS : Replace parameters specifically set by the user by calling the parameter Set method. (e.g. SetDiffuseColor())
vtkExternalLight::ALL_PARAMS : Replace all parameters of the light with the parameters in vtkExternalLight object.

virtual int vtkExternalLight::GetReplaceMode ( )

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)

vtkExternalLight::INDIVIDUAL_PARAMS : Replace parameters specifically set by the user by calling the parameter Set method. (e.g. SetDiffuseColor())
vtkExternalLight::ALL_PARAMS : Replace all parameters of the light with the parameters in vtkExternalLight object.

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

virtual