DI-Guy C++ SDK Reference  13.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diguyViewFogSettings.h
Go to the documentation of this file.
1 
2 /*********************************************************************
3  ** Copyright (c) 1992-2014 VT MAK
4  ** All rights reserved.
5  *********************************************************************/
6 
7 
8 
9 #ifndef __diguyViewFogSettings_H
10 #define __diguyViewFogSettings_H
11 
12 #ifdef SWIG
13 %module diguyViewFogSettings
14 #else
15 #define CPLUSPLUS_ONLY
16 #endif
17 
18 #ifdef CPLUSPLUS_ONLY
19 class bdiFog;
20 class diguyViewFogSettings;
21 
22 #include <diguy_constants.h>
23 
24 #endif
25 
26 
27 #include <declspec_diguy.h>
28 
29 /*********************************************************************/
47 class BDI_DECLSPEC_diguy diguyViewFogSettings
48 {
49 
50 public:
51 
52  /*l
53  *b Description:
54  **
55  ** The diguyViewLightSettings equivalent of
56  ** diguyViewLight::get_name().
57  */
58  const char* get_name();
59 
60  /*l
61  *b Description:
62  **
63  ** The diguyViewLightSettings equivalent of
64  ** diguyViewLight::get_type_name().
65  */
66  const char* get_type_name();
67 
68  /*l
69  *b Description:
70  **
71  ** The diguyViewLightSettings equivalent of
72  ** diguyViewLight::set_density().
73  */
74  void set_density(float density);
75 
76  /*l
77  *b Description:
78  **
79  ** The diguyViewLightSettings equivalent of
80  ** diguyViewLight::get_density().
81  */
82  float get_density();
83 
84  /*l
85  *b Description:
86  **
87  ** The diguyViewLightSettings equivalent of
88  ** diguyViewLight::set_start().
89  */
90  void set_start(float start);
91 
92  /*l
93  *b Description:
94  **
95  ** The diguyViewLightSettings equivalent of
96  ** diguyViewLight::get_start().
97  */
98  float get_start();
99 
100  /*l
101  *b Description:
102  **
103  ** The diguyViewLightSettings equivalent of
104  ** diguyViewLight::set_end().
105  */
106  void set_end(float end);
107 
108  /*l
109  *b Description:
110  **
111  ** The diguyViewLightSettings equivalent of
112  ** diguyViewLight::get_end().
113  */
114  float get_end();
115 
116  /*l
117  *b Description:
118  **
119  ** The diguyViewLightSettings equivalent of
120  ** diguyViewLight::set_color().
121  */
122  void set_color(float r, float g, float b, float a);
123 
124  /*l
125  *b Description:
126  **
127  ** The diguyViewLightSettings equivalent of
128  ** diguyViewLight::get_color().
129  */
130  void get_color(float* r, float* g, float* b, float* a);
131 
132  /*l
133  *b Description:
134  **
135  ** The diguyViewLightSettings equivalent of
136  ** diguyViewLight::set_fog_mode().
137  */
138  void set_fog_mode(int mode);
139 
140  /*l
141  *b Description:
142  **
143  ** The diguyViewLightSettings equivalent of
144  ** diguyViewLight::get_fog_mode().
145  */
146  int get_fog_mode();
147 
148 
153 #ifdef CPLUSPLUS_ONLY
154 
155  bdiFog* get_scripted_object() {return m_fog;}
156 
157 private:
158 
159  /*l
160  ** A private constructor.
161  */
162  diguyViewFogSettings(bdiFog* fog);
163 
164  /*l
165  ** A pointer to internal data.
166  */
167  bdiFog* m_fog;
168 
169  friend class bdiFog;
170 
171 #endif
172 
173 };
174 
175 #endif /* __diguyViewFogSettings_H */
176