VTK
vtkExternalLight.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkExternalLight.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
55 #ifndef vtkExternalLight_h
56 #define vtkExternalLight_h
57 
58 #include "vtkRenderingExternalModule.h" // For export macro
59 #include "vtkLight.h"
60 
61 class VTKRENDERINGEXTERNAL_EXPORT vtkExternalLight : public vtkLight
62 {
63 public:
64  vtkTypeMacro(vtkExternalLight, vtkLight);
65  void PrintSelf(ostream& os, vtkIndent indent);
66 
76  static vtkExternalLight *New();
77 
79  {
80  INDIVIDUAL_PARAMS = 0, // default
81  ALL_PARAMS = 1
82  };
83 
85 
90  vtkSetMacro(LightIndex, int);
91  vtkGetMacro(LightIndex, int);
93 
95 
108  vtkSetMacro(ReplaceMode, int);
109  vtkGetMacro(ReplaceMode, int);
111 
115  void SetPosition(double, double, double);
116 
120  void SetFocalPoint(double, double, double);
121 
125  void SetAmbientColor(double, double, double);
126 
130  void SetDiffuseColor(double, double, double);
131 
135  void SetSpecularColor(double, double, double);
136 
140  void SetIntensity(double);
141 
145  void SetConeAngle(double);
146 
150  void SetAttenuationValues(double, double, double);
151 
155  void SetExponent(double);
156 
160  void SetPositional(int);
161 
163 
166  vtkGetMacro(PositionSet, bool);
168 
170 
173  vtkGetMacro(FocalPointSet, bool);
175 
177 
180  vtkGetMacro(AmbientColorSet, bool);
182 
184 
187  vtkGetMacro(DiffuseColorSet, bool);
189 
191 
194  vtkGetMacro(SpecularColorSet, bool);
196 
198 
201  vtkGetMacro(IntensitySet, bool);
203 
205 
208  vtkGetMacro(ConeAngleSet, bool);
210 
212 
215  vtkGetMacro(AttenuationValuesSet, bool);
217 
219 
222  vtkGetMacro(ExponentSet, bool);
224 
226 
229  vtkGetMacro(PositionalSet, bool);
231 
232 protected:
235 
238 
249 
250 private:
251  vtkExternalLight(const vtkExternalLight&) VTK_DELETE_FUNCTION;
252  void operator=(const vtkExternalLight&) VTK_DELETE_FUNCTION;
253 };
254 
255 #endif // vtkExternalLight_h
vtkExternalLight::SetSpecularColor
void SetSpecularColor(double, double, double)
Override Set method to keep a record of changed value.
vtkExternalLight::SetAmbientColor
void SetAmbientColor(double, double, double)
Override Set method to keep a record of changed value.
vtkExternalLight::vtkExternalLight
vtkExternalLight()
vtkLight.h
vtkLight
a virtual light for 3D rendering
Definition: vtkLight.h:62
vtkExternalLight::SetConeAngle
void SetConeAngle(double)
Override Set method to keep a record of changed value.
vtkExternalLight::AttenuationValuesSet
bool AttenuationValuesSet
Definition: vtkExternalLight.h:246
vtkExternalLight::SetDiffuseColor
void SetDiffuseColor(double, double, double)
Override Set method to keep a record of changed value.
vtkExternalLight::ExponentSet
bool ExponentSet
Definition: vtkExternalLight.h:247
vtkExternalLight::ReplaceMode
int ReplaceMode
Definition: vtkExternalLight.h:237
vtkExternalLight::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkExternalLight::SetFocalPoint
void SetFocalPoint(double, double, double)
Override Set method to keep a record of changed value.
vtkExternalLight::IntensitySet
bool IntensitySet
Definition: vtkExternalLight.h:244
vtkExternalLight::FocalPointSet
bool FocalPointSet
Definition: vtkExternalLight.h:240
vtkExternalLight::PositionSet
bool PositionSet
Definition: vtkExternalLight.h:239
vtkExternalLight
a virtual light object for tweaking existing lights in an external 3D rendering context
Definition: vtkExternalLight.h:62
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkExternalLight::SetPosition
void SetPosition(double, double, double)
Override Set method to keep a record of changed value.
vtkExternalLight::DiffuseColorSet
bool DiffuseColorSet
Definition: vtkExternalLight.h:242
vtkExternalLight::SetAttenuationValues
void SetAttenuationValues(double, double, double)
Override Set method to keep a record of changed value.
vtkExternalLight::ReplaceModes
ReplaceModes
Definition: vtkExternalLight.h:79
vtkExternalLight::ConeAngleSet
bool ConeAngleSet
Definition: vtkExternalLight.h:245
vtkExternalLight::New
static vtkExternalLight * New()
Create an external light object with the focal point at the origin and its position set to (0,...
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkExternalLight::~vtkExternalLight
~vtkExternalLight()
vtkExternalLight::SetExponent
void SetExponent(double)
Override Set method to keep a record of changed value.
vtkExternalLight::LightIndex
int LightIndex
Definition: vtkExternalLight.h:236
vtkExternalLight::SpecularColorSet
bool SpecularColorSet
Definition: vtkExternalLight.h:243
vtkExternalLight::SetIntensity
void SetIntensity(double)
Override Set method to keep a record of changed value.
vtkExternalLight::SetPositional
void SetPositional(int)
Override Set method to keep a record of changed value.
vtkExternalLight::PositionalSet
bool PositionalSet
Definition: vtkExternalLight.h:248
vtkExternalLight::AmbientColorSet
bool AmbientColorSet
Definition: vtkExternalLight.h:241