fixed: auto_ptr -> unique_ptr
[opensg.git] / Source / System / Material / Base / OSGSimpleMaterial.fcd
blobb07352e7c70ed451adc31073e4dfefedce1afff5
1 <?xml version="1.0" ?>
3 <FieldContainer
4 name="SimpleMaterial"
5 parent="ChunkMaterial"
6 library="System"
7 structure="concrete"
8 pointerfieldtypes="none"
9 systemcomponent="true"
10 parentsystemcomponent="true"
11 docGroupBase="GrpSystemMaterial"
14 The simple material class. See \ref PageSystemMaterialSimpleMaterial for a
15 description.
17 This material wraps the standard calls to glMaterial() in
18 OSG::SimpleMaterial::_sfAmbient, OSG::SimpleMaterial::_sfDiffuse,
19 OSG::SimpleMaterial::_sfEmission, OSG::SimpleMaterial::_sfSpecular,
20 OSG::SimpleMaterial::_sfShininess. In addition it supports transparency
21 (OSG::SimpleMaterial::_sfTransparency), can switch lighting
22 (OSG::SimpleMaterial::_sfLit) and the color material
23 (OSG::SimpleMaterial::_sfColorMaterial).
24 <Field
25 name="ambient"
26 type="Color3f"
27 cardinality="single"
28 visibility="external"
29 defaultValue="0.f,0.f,0.f"
31 The ambient color for the material.
32 </Field>
33 <Field
34 name="diffuse"
35 type="Color3f"
36 cardinality="single"
37 visibility="external"
38 defaultValue="0.f,0.f,0.f"
40 The diffuse color for the material.
41 </Field>
42 <Field
43 name="specular"
44 type="Color3f"
45 cardinality="single"
46 visibility="external"
47 defaultValue="0.f,0.f,0.f"
49 The color used for the specular highlight on the object.
50 </Field>
51 <Field
52 name="shininess"
53 type="Real32"
54 cardinality="single"
55 visibility="external"
56 defaultValue="1.f"
57 min_value="0.0"
58 max_value="128.0"
60 The shininess value to use when lighting the object. Higher values equal smaller and brighter highlights.
61 </Field>
62 <Field
63 name="emission"
64 type="Color3f"
65 cardinality="single"
66 visibility="external"
67 defaultValue="0.f,0.f,0.f"
69 </Field>
70 <Field
71 name="transparency"
72 type="Real32"
73 cardinality="single"
74 visibility="external"
75 defaultValue="0.f"
76 min_value="0.0"
77 max_value="1.0"
79 Defines how transparent objects are rendered with this material.
80 </Field>
81 <Field
82 name="lit"
83 type="bool"
84 cardinality="single"
85 visibility="external"
86 defaultValue="true"
88 </Field>
89 <Field
90 name="colorMaterial"
91 type="GLenum"
92 cardinality="single"
93 visibility="external"
94 defaultValue="GL_DIFFUSE"
95 defaultHeader="&quot;OSGGL.h&quot;"
96 potential_values="GL_AMBIENT,GL_DIFFUSE,GL_SPECULAR,GL_AMBIENT_AND_DIFFUSE,GL_EMISSION"
98 Defines which color material mode this material affects.
99 </Field>
100 </FieldContainer>