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

a cone and a frustum to represent a spotlight. More...

#include <vtkLightActor.h>

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

Public Types

typedef vtkProp3D Superclass
- Public Types inherited from vtkProp3D
typedef vtkProp Superclass
- Public Types inherited from vtkProp
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int HasTranslucentPolygonalGeometry ()
void ReleaseGraphicsResources (vtkWindow *)
double * GetBounds ()
unsigned long int GetMTime ()
void SetLight (vtkLight *light)
virtual vtkLightGetLight ()
void SetClippingRange (double dNear, double dFar)
void SetClippingRange (const double a[2])
virtual double * GetClippingRange ()
virtual void GetClippingRange (double &, double &)
virtual void GetClippingRange (double[2])
- Public Member Functions inherited from vtkProp3D
void ShallowCopy (vtkProp *prop)
void SetScale (double s)
double * GetCenter ()
double * GetXRange ()
double * GetYRange ()
double * GetZRange ()
double GetLength ()
void RotateX (double)
void RotateY (double)
void RotateZ (double)
void RotateWXYZ (double, double, double, double)
void SetOrientation (double, double, double)
void SetOrientation (double a[3])
double * GetOrientationWXYZ ()
void AddOrientation (double, double, double)
void AddOrientation (double a[3])
void PokeMatrix (vtkMatrix4x4 *matrix)
void InitPathTraversal ()
unsigned long int GetUserTransformMatrixMTime ()
virtual void ComputeMatrix ()
virtual void SetPosition (double _arg1, double _arg2, double _arg3)
virtual void SetPosition (double _arg[3])
virtual double * GetPosition ()
virtual void GetPosition (double data[3])
void AddPosition (double deltaPosition[3])
void AddPosition (double deltaX, double deltaY, double deltaZ)
virtual void SetOrigin (double _arg1, double _arg2, double _arg3)
virtual void SetOrigin (double _arg[3])
virtual double * GetOrigin ()
virtual void GetOrigin (double data[3])
virtual void SetScale (double _arg1, double _arg2, double _arg3)
virtual void SetScale (double _arg[3])
virtual double * GetScale ()
virtual void GetScale (double data[3])
void SetUserTransform (vtkLinearTransform *transform)
virtual vtkLinearTransformGetUserTransform ()
void SetUserMatrix (vtkMatrix4x4 *matrix)
vtkMatrix4x4GetUserMatrix ()
virtual void GetMatrix (vtkMatrix4x4 *m)
virtual void GetMatrix (double m[16])
void GetBounds (double bounds[6])
double * GetOrientation ()
void GetOrientation (double o[3])
vtkMatrix4x4GetMatrix ()
virtual int GetIsIdentity ()
- Public Member Functions inherited from vtkProp
virtual void Pick ()
virtual unsigned long GetRedrawMTime ()
virtual bool HasKeys (vtkInformation *requiredKeys)
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void GetActors (vtkPropCollection *)
virtual void GetActors2D (vtkPropCollection *)
virtual void GetVolumes (vtkPropCollection *)
virtual void SetVisibility (int)
virtual int GetVisibility ()
virtual void VisibilityOn ()
virtual void VisibilityOff ()
virtual void SetPickable (int)
virtual int GetPickable ()
virtual void PickableOn ()
virtual void PickableOff ()
virtual void SetDragable (int)
virtual int GetDragable ()
virtual void DragableOn ()
virtual void DragableOff ()
virtual void SetUseBounds (bool)
virtual bool GetUseBounds ()
virtual void UseBoundsOn ()
virtual void UseBoundsOff ()
virtual vtkAssemblyPathGetNextPath ()
virtual int GetNumberOfPaths ()
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkInformationGetPropertyKeys ()
virtual void SetPropertyKeys (vtkInformation *keys)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int RenderVolumetricGeometry (vtkViewport *)
virtual int RenderOverlay (vtkViewport *)
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
virtual double GetEstimatedRenderTime (vtkViewport *)
virtual double GetEstimatedRenderTime ()
virtual void SetEstimatedRenderTime (double t)
virtual void RestoreEstimatedRenderTime ()
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
virtual double GetAllocatedRenderTime ()
void SetRenderTimeMultiplier (double t)
virtual double GetRenderTimeMultiplier ()
virtual bool GetSupportsSelection ()
virtual int GetNumberOfConsumers ()
void AddConsumer (vtkObject *c)
void RemoveConsumer (vtkObject *c)
vtkObjectGetConsumer (int i)
int IsConsumer (vtkObject *c)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkLightActorNew ()
static int IsTypeOf (const char *type)
static vtkLightActorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkLightActor ()
 ~vtkLightActor ()
void UpdateViewProps ()
- Protected Member Functions inherited from vtkProp3D
 vtkProp3D ()
 ~vtkProp3D ()
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 ~vtkProp ()
- 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkLightLight
double ClippingRange [2]
vtkConeSourceConeSource
vtkPolyDataMapperConeMapper
vtkActorConeActor
vtkCameraCameraLight
vtkCameraActorFrustumActor
vtkBoundingBoxBoundingBox
- Protected Attributes inherited from vtkProp3D
vtkLinearTransformUserTransform
vtkMatrix4x4UserMatrix
vtkMatrix4x4Matrix
vtkTimeStamp MatrixMTime
double Origin [3]
double Position [3]
double Orientation [3]
double Scale [3]
double Center [3]
vtkTransformTransform
double Bounds [6]
vtkProp3DCachedProp3D
int IsIdentity
- Protected Attributes inherited from vtkProp
int Visibility
int Pickable
int Dragable
bool UseBounds
double AllocatedRenderTime
double EstimatedRenderTime
double SavedEstimatedRenderTime
double RenderTimeMultiplier
int NumberOfConsumers
vtkObject ** Consumers
vtkAssemblyPathsPaths
vtkInformationPropertyKeys
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

a cone and a frustum to represent a spotlight.

vtkLightActor is a composite actor used to represent a spotlight. The cone angle is equal to the spotlight angle, the cone apex is at the position of the light, the direction of the light goes from the cone apex to the center of the base of the cone. The square frustum position is the light position, the frustum focal point is in the direction of the light direction. The frustum vertical view angle (aperture) (this is also the horizontal view angle as the frustum is square) is equal to twice the cone angle. The clipping range of the frustum is arbitrary set by the user (initially at 0.5,11.0).

Warning
Right now only spotlight are supported but directional light might be supported in the future.
See Also
vtkLight vtkConeSource vtkFrustumSource vtkCameraActor
Tests:
vtkLightActor (Tests)

Definition at line 52 of file vtkLightActor.h.

Member Typedef Documentation

Definition at line 56 of file vtkLightActor.h.

Constructor & Destructor Documentation

vtkLightActor::vtkLightActor ( )
protected
vtkLightActor::~vtkLightActor ( )
protected

Member Function Documentation

static vtkLightActor* vtkLightActor::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkLightActor::GetClassName ( )
virtual

Reimplemented from vtkProp3D.

static int vtkLightActor::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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 vtkProp3D.

virtual int vtkLightActor::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 vtkProp3D.

static vtkLightActor* vtkLightActor::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkProp3D.

void vtkLightActor::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 vtkProp3D.

void vtkLightActor::SetLight ( vtkLight light)

The spotlight to represent. Initial value is NULL.

virtual vtkLight* vtkLightActor::GetLight ( )
virtual

The spotlight to represent. Initial value is NULL.

void vtkLightActor::SetClippingRange ( double  dNear,
double  dFar 
)

Set/Get the location of the near and far clipping planes along the direction of projection. Both of these values must be positive. Initial values are (0.5,11.0)

void vtkLightActor::SetClippingRange ( const double  a[2])

Set/Get the location of the near and far clipping planes along the direction of projection. Both of these values must be positive. Initial values are (0.5,11.0)

virtual double* vtkLightActor::GetClippingRange ( )
virtual

Set/Get the location of the near and far clipping planes along the direction of projection. Both of these values must be positive. Initial values are (0.5,11.0)

virtual void vtkLightActor::GetClippingRange ( double &  ,
double &   
)
virtual

Set/Get the location of the near and far clipping planes along the direction of projection. Both of these values must be positive. Initial values are (0.5,11.0)

virtual void vtkLightActor::GetClippingRange ( double  [2])
virtual

Set/Get the location of the near and far clipping planes along the direction of projection. Both of these values must be positive. Initial values are (0.5,11.0)

virtual int vtkLightActor::RenderOpaqueGeometry ( vtkViewport viewport)
virtual

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkLightActor::HasTranslucentPolygonalGeometry ( )
virtual

Does this prop have some translucent polygonal geometry? No.

Reimplemented from vtkProp.

void vtkLightActor::ReleaseGraphicsResources ( vtkWindow )
virtual

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

double* vtkLightActor::GetBounds ( )
virtual

Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Implements vtkProp3D.

unsigned long int vtkLightActor::GetMTime ( )
virtual

Get the actors mtime plus consider its properties and texture if set.

Reimplemented from vtkProp3D.

void vtkLightActor::UpdateViewProps ( )
protected

Member Data Documentation

vtkLight* vtkLightActor::Light
protected

Definition at line 98 of file vtkLightActor.h.

double vtkLightActor::ClippingRange[2]
protected

Definition at line 99 of file vtkLightActor.h.

vtkConeSource* vtkLightActor::ConeSource
protected

Definition at line 101 of file vtkLightActor.h.

vtkPolyDataMapper* vtkLightActor::ConeMapper
protected

Definition at line 102 of file vtkLightActor.h.

vtkActor* vtkLightActor::ConeActor
protected

Definition at line 103 of file vtkLightActor.h.

vtkCamera* vtkLightActor::CameraLight
protected

Definition at line 105 of file vtkLightActor.h.

vtkCameraActor* vtkLightActor::FrustumActor
protected

Definition at line 106 of file vtkLightActor.h.

vtkBoundingBox* vtkLightActor::BoundingBox
protected

Definition at line 108 of file vtkLightActor.h.


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