VTK  9.3.20240614
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWebGPULight Class Reference

OpenGL light. More...

#include <vtkWebGPULight.h>

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

Classes

struct  LightInfo
 

Public Types

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.
 
vtkWebGPULightNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void CacheLightInformation (vtkRenderer *renderer, vtkCamera *camera)
 
const void * GetCachedLightInformation ()
 
void Render (vtkRenderer *, int) override
 Abstract interface to renderer.
 
- Public Member Functions inherited from vtkLight
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkLightNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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).
 
virtual void Render (vtkRenderer *, int)
 Abstract interface to renderer.
 
void TransformPoint (double a[3], double b[3])
 Use transform matrix to transform point (if it exists).
 
void TransformVector (double a[3], double b[3])
 Use transform matrix to transform vector (if it exists).
 
void DeepCopy (vtkLight *light)
 Perform deep copy of this light.
 
virtual void SetAmbientColor (double, double, double)
 Set/Get the color of the light.
 
virtual void SetAmbientColor (double[3])
 Set/Get the color of the light.
 
virtual double * GetAmbientColor ()
 Set/Get the color of the light.
 
virtual void GetAmbientColor (double data[3])
 Set/Get the color of the light.
 
virtual void SetDiffuseColor (double, double, double)
 Set/Get the color of the light.
 
virtual void SetDiffuseColor (double[3])
 Set/Get the color of the light.
 
virtual double * GetDiffuseColor ()
 Set/Get the color of the light.
 
virtual void GetDiffuseColor (double data[3])
 Set/Get the color of the light.
 
virtual void SetSpecularColor (double, double, double)
 Set/Get the color of the light.
 
virtual void SetSpecularColor (double[3])
 Set/Get the color of the light.
 
virtual double * GetSpecularColor ()
 Set/Get the color of the light.
 
virtual void GetSpecularColor (double data[3])
 Set/Get the color of the light.
 
void SetColor (double, double, double)
 Set/Get the color of the light.
 
void SetColor (const double a[3])
 Set/Get the color of the light.
 
virtual void SetPosition (double, double, double)
 Set/Get the position of the light.
 
virtual void SetPosition (double[3])
 Set/Get the position of the light.
 
virtual double * GetPosition ()
 Set/Get the position of the light.
 
virtual void GetPosition (double data[3])
 Set/Get the position of the light.
 
void SetPosition (const float *a)
 Set/Get the position of the light.
 
virtual void SetFocalPoint (double, double, double)
 Set/Get the point at which the light is shining.
 
virtual void SetFocalPoint (double[3])
 Set/Get the point at which the light is shining.
 
virtual double * GetFocalPoint ()
 Set/Get the point at which the light is shining.
 
virtual void GetFocalPoint (double data[3])
 Set/Get the point at which the light is shining.
 
void SetFocalPoint (const float *a)
 Set/Get the point at which the light is shining.
 
virtual void SetIntensity (double)
 Set/Get the brightness of the light (from one to zero).
 
virtual double GetIntensity ()
 Set/Get the brightness of the light (from one to zero).
 
virtual void SetSwitch (vtkTypeBool)
 Turn the light on or off.
 
virtual vtkTypeBool GetSwitch ()
 Turn the light on or off.
 
virtual void SwitchOn ()
 Turn the light on or off.
 
virtual void SwitchOff ()
 Turn the light on or off.
 
virtual void SetPositional (vtkTypeBool)
 Turn positional lighting on or off.
 
virtual vtkTypeBool GetPositional ()
 Turn positional lighting on or off.
 
virtual void PositionalOn ()
 Turn positional lighting on or off.
 
virtual void PositionalOff ()
 Turn positional lighting on or off.
 
virtual void SetExponent (double)
 Set/Get the exponent of the cosine used in positional lighting.
 
virtual double GetExponent ()
 Set/Get the exponent of the cosine used in positional lighting.
 
virtual void SetConeAngle (double)
 Set/Get the lighting cone angle of a positional light in degrees.
 
virtual double GetConeAngle ()
 Set/Get the lighting cone angle of a positional light in degrees.
 
virtual void SetAttenuationValues (double, double, double)
 Set/Get the quadratic attenuation constants.
 
virtual void SetAttenuationValues (double[3])
 Set/Get the quadratic attenuation constants.
 
virtual double * GetAttenuationValues ()
 Set/Get the quadratic attenuation constants.
 
virtual void GetAttenuationValues (double data[3])
 Set/Get the quadratic attenuation constants.
 
virtual void SetTransformMatrix (vtkMatrix4x4 *)
 Set/Get the light's transformation matrix.
 
virtual vtkMatrix4x4GetTransformMatrix ()
 Set/Get the light's transformation matrix.
 
void GetTransformedPosition (double &x, double &y, double &z)
 Get the position of the light, modified by the transformation matrix (if it exists).
 
void GetTransformedPosition (double a[3])
 Get the position of the light, modified by the transformation matrix (if it exists).
 
double * GetTransformedPosition ()
 Get the position of the light, modified by the transformation matrix (if it exists).
 
void GetTransformedFocalPoint (double &x, double &y, double &z)
 Get the focal point of the light, modified by the transformation matrix (if it exists).
 
void GetTransformedFocalPoint (double a[3])
 Get the focal point of the light, modified by the transformation matrix (if it exists).
 
double * GetTransformedFocalPoint ()
 Get the focal point of the light, modified by the transformation matrix (if it exists).
 
void SetDirectionAngle (double elevation, double azimuth)
 Set the position and focal point of a light based on elevation and azimuth.
 
void SetDirectionAngle (const double ang[2])
 Set the position and focal point of a light based on elevation and azimuth.
 
virtual void SetLightType (int)
 Set/Get the type of the light.
 
virtual int GetLightType ()
 Set/Get the type of the light.
 
void SetLightTypeToHeadlight ()
 Set/Get the type of the light.
 
void SetLightTypeToSceneLight ()
 Set/Get the type of the light.
 
void SetLightTypeToCameraLight ()
 Set/Get the type of the light.
 
int LightTypeIsHeadlight ()
 Query the type of the light.
 
int LightTypeIsSceneLight ()
 Query the type of the light.
 
int LightTypeIsCameraLight ()
 Query the type of the light.
 
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.
 
virtual float GetShadowAttenuation ()
 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.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with the light.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with the light.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkWebGPULightNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWebGPULightSafeDownCast (vtkObjectBase *o)
 
static std::size_t GetCacheSizeBytes ()
 
- 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).
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWebGPULight ()=default
 
 ~vtkWebGPULight () override=default
 
- Protected Member Functions inherited from vtkLight
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

LightInfo CachedLightInfo
 
- 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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

OpenGL light.

vtkWebGPULight is a concrete implementation of the abstract class vtkLight. vtkWebGPULight interfaces to the OpenGL rendering library.

Definition at line 22 of file vtkWebGPULight.h.

Member Typedef Documentation

◆ Superclass

Definition at line 26 of file vtkWebGPULight.h.

Constructor & Destructor Documentation

◆ vtkWebGPULight()

vtkWebGPULight::vtkWebGPULight ( )
protecteddefault

◆ ~vtkWebGPULight()

vtkWebGPULight::~vtkWebGPULight ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkWebGPULight * vtkWebGPULight::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkWebGPULight::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 vtkWebGPULight * vtkWebGPULight::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWebGPULight::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkLight.

◆ NewInstance()

vtkWebGPULight * vtkWebGPULight::NewInstance ( ) const

◆ PrintSelf()

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

◆ CacheLightInformation()

void vtkWebGPULight::CacheLightInformation ( vtkRenderer renderer,
vtkCamera camera 
)

◆ GetCachedLightInformation()

const void * vtkWebGPULight::GetCachedLightInformation ( )
inline

Definition at line 30 of file vtkWebGPULight.h.

◆ GetCacheSizeBytes()

static std::size_t vtkWebGPULight::GetCacheSizeBytes ( )
inlinestatic

Definition at line 31 of file vtkWebGPULight.h.

◆ Render()

void vtkWebGPULight::Render ( vtkRenderer ,
int   
)
overridevirtual

Abstract interface to renderer.

Each concrete subclass of vtkLight will load its data into the graphics system in response to this method invocation. The actual loading is performed by a vtkLightDevice subclass, which will get created automatically.

Reimplemented from vtkLight.

Member Data Documentation

◆ CachedLightInfo

LightInfo vtkWebGPULight::CachedLightInfo
protected

Definition at line 54 of file vtkWebGPULight.h.


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