1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to
// this header file considered to be the "object code" form of the original source.
#ifndef _Graphic3d_MaterialAspect_HeaderFile
#define _Graphic3d_MaterialAspect_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif
#ifndef _Standard_ShortReal_HeaderFile
#include <Standard_ShortReal.hxx>
#endif
#ifndef _Quantity_Color_HeaderFile
#include <Quantity_Color.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Graphic3d_TypeOfMaterial_HeaderFile
#include <Graphic3d_TypeOfMaterial.hxx>
#endif
#ifndef _Graphic3d_NameOfMaterial_HeaderFile
#include <Graphic3d_NameOfMaterial.hxx>
#endif
#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Graphic3d_TypeOfReflection_HeaderFile
#include <Graphic3d_TypeOfReflection.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
class Graphic3d_MaterialDefinitionError;
class Standard_OutOfRange;
class Quantity_Color;
//! This class allows the definition of the type of a surface. <br>
//! Keywords: Material, FillArea, Shininess, Ambient, Color, Diffuse, <br>
//! Specular, Transparency, Emissive, ReflectionMode, <br>
//! BackFace, FrontFace, Reflection, Absorbtion <br>
class Graphic3d_MaterialAspect {
public:
void* operator new(size_t,void* anAddress)
{
return anAddress;
}
void* operator new(size_t size)
{
return Standard::Allocate(size);
}
void operator delete(void *anAddress)
{
if (anAddress) Standard::Free((Standard_Address&)anAddress);
}
//! Creates a material from default values. <br>
Standard_EXPORT Graphic3d_MaterialAspect();
//! Creates a generic material calls <AName> <br>
Standard_EXPORT Graphic3d_MaterialAspect(const Graphic3d_NameOfMaterial AName);
//! Increases or decreases the luminosity of <me>. <br>
//! <ADelta> is a signed percentage. <br>
Standard_EXPORT void IncreaseShine(const Standard_Real ADelta) ;
//! Modifies the reflection properties of the surface. <br>
//! Category: Methods to modify the class definition <br>
//! Warning: Raises MaterialDefinitionError if <AValue> is <br>
//! a negative value or greater than 1.0. <br>
Standard_EXPORT void SetAmbient(const Standard_Real AValue) ;
//! Modifies the reflection properties of the surface. <br>
//! Category: Methods to modify the class definition <br>
//! Warning: Raises MaterialDefinitionError if <AValue> is a <br>
//! negative value or greater than 1.0. <br>
Standard_EXPORT void SetDiffuse(const Standard_Real AValue) ;
//! Modifies the reflection properties of the surface. <br>
//! Category: Methods to modify the class definition <br>
//! Warning: Raises MaterialDefinitionError if <AValue> is a <br>
//! negative value or greater than 1.0. <br>
Standard_EXPORT void SetEmissive(const Standard_Real AValue) ;
//! Modifies the luminosity of the surface. <br>
//! Category: Methods to modify the class definition <br>
//! Warning: Raises MaterialDefinitionError if <AValue> is a <br>
//! negative value or greater than 1.0. <br>
Standard_EXPORT void SetShininess(const Standard_Real AValue) ;
//! Modifies the reflection properties of the surface. <br>
//! Category: Methods to modify the class definition <br>
//! Warning: Raises MaterialDefinitionError if <AValue> is a <br>
//! negative value or greater than 1.0. <br>
Standard_EXPORT void SetSpecular(const Standard_Real AValue) ;
//! Modifies the transparency coefficient of the surface. <br>
//! <AValue> = 0. opaque. (default) <br>
//! <AValue> = 1. transparent. <br>
//! Transparency is applicable to materials that have at least <br>
//! one of reflection modes (ambient, diffuse, specular or emissive) <br>
//! enabled. See also SetReflectionModeOn() and SetReflectionModeOff() methods. <br>
//! <br>
//! NOTE: In order for transparency specified through this method to <br>
//! take effect, it is necessary to enable transparency <br>
//! in the viewer. This can be done either directly - <br>
//! see Visual3d_ViewManager::SetTransparency(Standard_Boolean), <br>
//! or indirectly - by calling AIS_InteractiveObject::SetTransparency() <br>
//! before an object is added to an interactive context, or by <br>
//! calling AIS_InteractiveContext::SetTransparency() for a given <br>
//! interactive object already displayed. <br>
//! Category: Methods to modify the class definition <br>
//! Warning: Raises MaterialDefinitionError if <AValue> is a <br>
//! negative value or greater than 1.0. <br>
Standard_EXPORT void SetTransparency(const Standard_Real AValue) ;
//! Modifies the ambient colour of the surface. <br>
//! Category: Methods to modify the class definition <br>
Standard_EXPORT void SetColor(const Quantity_Color& AColor) ;
//! Modifies the ambient colour of the surface. <br>
Standard_EXPORT void SetAmbientColor(const Quantity_Color& AColor) ;
//! Modifies the difuse colour of the surface. <br>
Standard_EXPORT void SetDiffuseColor(const Quantity_Color& AColor) ;
//! Modifies the specular colour of the surface. <br>
Standard_EXPORT void SetSpecularColor(const Quantity_Color& AColor) ;
//! Modifies the emissive colour of the surface. <br>
Standard_EXPORT void SetEmissiveColor(const Quantity_Color& AColor) ;
//! Activates the reflective properties of the surface <AType>. <br>
Standard_EXPORT void SetReflectionModeOn(const Graphic3d_TypeOfReflection AType) ;
//! Deactivates the reflective properties of <br>
//! the surface <AType>. <br>
Standard_EXPORT void SetReflectionModeOff(const Graphic3d_TypeOfReflection AType) ;
//! Set MyMaterialType to the value of parameter <AType> <br>
Standard_EXPORT void SetMaterialType(const Graphic3d_TypeOfMaterial AType) ;
//! The current matarial become a "UserDefined" material. <br>
//! Set the name of the "UserDefined" material. <br>
Standard_EXPORT void SetMaterialName(const Standard_CString AName) ;
Standard_EXPORT void SetEnvReflexion(const Standard_ShortReal AValue) ;
//! Resets the material with the original values according to <br>
//! the material name but leave the current color values untouched <br>
//! for the material of type ASPECT. <br>
Standard_EXPORT void Reset() ;
//! Returns the ambient colour of the surface. <br>
Standard_EXPORT Quantity_Color Color() const;
//! Returns the ambient colour of the surface. <br>
Standard_EXPORT Quantity_Color AmbientColor() const;
//! Returns the diffuse colour of the surface. <br>
Standard_EXPORT Quantity_Color DiffuseColor() const;
//! Returns the specular colour of the surface. <br>
Standard_EXPORT Quantity_Color SpecularColor() const;
//! Returns the emissive colour of the surface. <br>
Standard_EXPORT Quantity_Color EmissiveColor() const;
//! Returns the reflection properties of the surface. <br>
Standard_EXPORT Standard_Real Ambient() const;
//! Returns the reflection properties of the surface. <br>
Standard_EXPORT Standard_Real Diffuse() const;
//! Returns the reflection properties of the surface. <br>
Standard_EXPORT Standard_Real Specular() const;
//! Returns the transparency coefficient of the surface. <br>
Standard_EXPORT Standard_Real Transparency() const;
//! Returns the emissive coefficient of the surface. <br>
Standard_EXPORT Standard_Real Emissive() const;
//! Returns the luminosity of the surface. <br>
Standard_EXPORT Standard_Real Shininess() const;
//! Returns Standard_True if the reflection mode is active, <br>
//! Standard_False otherwise. <br>
Standard_EXPORT Standard_Boolean ReflectionMode(const Graphic3d_TypeOfReflection AType) const;
//! Returns Standard_True if MyMaterialType equal the parameter AType, <br>
//! Standard_False otherwise. <br>
Standard_EXPORT Standard_Boolean MaterialType(const Graphic3d_TypeOfMaterial AType) const;
Standard_EXPORT Standard_ShortReal EnvReflexion() const;
//! Returns the material name. <br>
Standard_EXPORT Graphic3d_NameOfMaterial Name() const;
//! Returns Standard_True if the materials <me> and <br>
//! <Other> are different. <br>
Standard_EXPORT Standard_Boolean IsDifferent(const Graphic3d_MaterialAspect& Other) const;
Standard_Boolean operator !=(const Graphic3d_MaterialAspect& Other) const
{
return IsDifferent(Other);
}
//! Returns Standard_True if the materials <me> and <br>
//! <Other> are identical. <br>
Standard_EXPORT Standard_Boolean IsEqual(const Graphic3d_MaterialAspect& Other) const;
Standard_Boolean operator ==(const Graphic3d_MaterialAspect& Other) const
{
return IsEqual(Other);
}
//! Returns the number of predefined textures. <br>
Standard_EXPORT static Standard_Integer NumberOfMaterials() ;
//! Returns the name of the predefined material of rank <aRank> <br>
//! Trigger: when <aRank> is < 1 or > NumberOfMaterials. <br>
Standard_EXPORT static Standard_CString MaterialName(const Standard_Integer aRank) ;
//! Returns the name of this material <br>
Standard_EXPORT Standard_CString MaterialName() const;
//! Returns the type of the predefined material of rank <aRank> <br>
//! Trigger: when <aRank> is < 1 or > NumberOfMaterials. <br>
Standard_EXPORT static Graphic3d_TypeOfMaterial MaterialType(const Standard_Integer aRank) ;
protected:
private:
Standard_EXPORT void Init(const Graphic3d_NameOfMaterial AName) ;
Standard_ShortReal MyDiffuseCoef;
Quantity_Color MyDiffuseColor;
Standard_Boolean MyDiffuseActivity;
Standard_ShortReal MyAmbientCoef;
Quantity_Color MyAmbientColor;
Standard_Boolean MyAmbientActivity;
Standard_ShortReal MySpecularCoef;
Quantity_Color MySpecularColor;
Standard_Boolean MySpecularActivity;
Standard_ShortReal MyEmissiveCoef;
Quantity_Color MyEmissiveColor;
Standard_Boolean MyEmissiveActivity;
Standard_ShortReal MyTransparencyCoef;
Standard_ShortReal MyShininess;
Standard_ShortReal MyEnvReflexion;
Graphic3d_TypeOfMaterial MyMaterialType;
Graphic3d_NameOfMaterial MyMaterialName;
Graphic3d_NameOfMaterial MyRequestedMaterialName;
TCollection_AsciiString MyStringName;
};
// other Inline functions and methods (like "C++: function call" methods)
#endif
|
