vtkLightActor Class Reference

#include <vtkLightActor.h>

Inheritance diagram for vtkLightActor:

Inheritance graph
[legend]
Collaboration diagram for vtkLightActor:

Collaboration graph
[legend]

List of all members.


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.


Public Types

typedef vtkProp3D 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])

Static Public Member Functions

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

Protected Member Functions

 vtkLightActor ()
 ~vtkLightActor ()
void UpdateViewProps ()

Protected Attributes

vtkLightLight
double ClippingRange [2]
vtkConeSourceConeSource
vtkPolyDataMapperConeMapper
vtkActorConeActor
vtkCameraCameraLight
vtkCameraActorFrustumActor
vtkBoundingBoxBoundingBox

Member Typedef Documentation

Reimplemented from vtkProp3D.

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

Definition at line 98 of file vtkLightActor.h.

double vtkLightActor::ClippingRange[2] [protected]

Definition at line 99 of file vtkLightActor.h.

Definition at line 101 of file vtkLightActor.h.

Definition at line 102 of file vtkLightActor.h.

Definition at line 103 of file vtkLightActor.h.

Definition at line 105 of file vtkLightActor.h.

Definition at line 106 of file vtkLightActor.h.

Definition at line 108 of file vtkLightActor.h.


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

Generated on Mon Sep 27 18:32:29 2010 for VTK by  doxygen 1.5.6