vtkOSPRayLightNode.h 2.76 KB
Newer Older
1
2
3
/*=========================================================================

  Program:   Visualization Toolkit
David DeMarle's avatar
David DeMarle committed
4
  Module:    vtkOSPRayLightNode.h
5
6
7
8
9
10
11
12
13
14

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
15
16
17
18
19
20
/**
 * @class   vtkOSPRayLightNode
 * @brief   links vtkLights to OSPRay
 *
 * Translates vtkLight state into OSPRay rendering calls
*/
21

David DeMarle's avatar
David DeMarle committed
22
23
#ifndef vtkOSPRayLightNode_h
#define vtkOSPRayLightNode_h
24

David DeMarle's avatar
David DeMarle committed
25
#include "vtkRenderingOSPRayModule.h" // For export macro
26
27
#include "vtkLightNode.h"

Utkarsh Ayachit's avatar
Utkarsh Ayachit committed
28
29
#include <string> // for std::string

30
class vtkInformationDoubleKey;
31
32
class vtkInformationIntegerKey;
class vtkLight;
33
34
35
36
37
38
39
class vtkOSPRayRendererNode;

namespace osp
{
struct Light;
struct Renderer;
}
40

David DeMarle's avatar
David DeMarle committed
41
class VTKRENDERINGOSPRAY_EXPORT vtkOSPRayLightNode :
42
43
44
  public vtkLightNode
{
public:
David DeMarle's avatar
David DeMarle committed
45
46
  static vtkOSPRayLightNode* New();
  vtkTypeMacro(vtkOSPRayLightNode, vtkLightNode);
47
  void PrintSelf(ostream& os, vtkIndent indent) override;
48

49
50
51
  /**
   * Make ospray calls to render me.
   */
52
  virtual void Render(bool prepass) override;
53

54
55
56
57
58
  //@{
  /**
   * A global multiplier to all ospray lights.
   * default is 1.0
   */
59
60
  static void SetLightScale(double s);
  static double GetLightScale();
61
  //@}
62

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
  //state beyond rendering core...

  /**
   * When present on light, the light acts as an ambient source.
   * An AmbientLight is one that has no specific position in space and for
   * which only the ambient color term affects the result.
   */
  static vtkInformationIntegerKey* IS_AMBIENT();

  //@{
  /**
   * Convenience method to set/get IS_AMBIENT on a vtkLight.
   */
  static void SetIsAmbient(int, vtkLight *);
  static int GetIsAmbient(vtkLight *);
  //@}

80
81
82
83
84
85
86
87
88
89
90
91
92
93
  /**
   * The radius setting, when > 0.0, produces soft shadows in the
   * path tracer.
   */
  static vtkInformationDoubleKey* RADIUS();

  //@{
  /**
   * Convenience method to set/get RADIUS on a vtkLight.
   */
  static void SetRadius(double, vtkLight *);
  static double GetRadius(vtkLight *);
  //@}

94
95
96
97
98
99
100
  /**
   * Select the version-appropriate signature for ospNewLight.
   */
  static osp::Light* NewLight(vtkOSPRayRendererNode *orn,
                              osp::Renderer *oRenderer,
                              const std::string& lightType);

101
protected:
David DeMarle's avatar
David DeMarle committed
102
103
  vtkOSPRayLightNode();
  ~vtkOSPRayLightNode();
104
105

private:
106
107
  vtkOSPRayLightNode(const vtkOSPRayLightNode&) = delete;
  void operator=(const vtkOSPRayLightNode&) = delete;
108
109

  static double LightScale;
David E. DeMarle's avatar
David E. DeMarle committed
110
  void *OLight;
111
112
113
};

#endif