1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
---|
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
---|
3 | <title>FCollada: FCDLight Class Reference</title> |
---|
4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
---|
5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
---|
6 | </head><body> |
---|
7 | <!-- Generated by Doxygen 1.4.6-NO --> |
---|
8 | <div class="tabs"> |
---|
9 | <ul> |
---|
10 | <li><a href="index.html"><span>Main Page</span></a></li> |
---|
11 | <li><a href="modules.html"><span>Modules</span></a></li> |
---|
12 | <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
---|
13 | <li id="current"><a href="classes.html"><span>Classes</span></a></li> |
---|
14 | <li><a href="files.html"><span>Files</span></a></li> |
---|
15 | <li><a href="pages.html"><span>Related Pages</span></a></li> |
---|
16 | </ul></div> |
---|
17 | <div class="tabs"> |
---|
18 | <ul> |
---|
19 | <li><a href="classes.html"><span>Alphabetical List</span></a></li> |
---|
20 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
21 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
22 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
23 | </ul></div> |
---|
24 | <h1>FCDLight Class Reference<br> |
---|
25 | <small> |
---|
26 | [<a class="el" href="group___f_c_document.html">COLLADA Document Object Model.</a>]</small> |
---|
27 | </h1><!-- doxytag: class="FCDLight" --><!-- doxytag: inherits="FCDTargetedEntity" -->A COLLADA light. |
---|
28 | <a href="#_details">More...</a> |
---|
29 | <p> |
---|
30 | <code>#include <<a class="el" href="_f_c_d_light_8h-source.html">FCDLight.h</a>></code> |
---|
31 | <p> |
---|
32 | <p>Inheritance diagram for FCDLight: |
---|
33 | <p><center><img src="class_f_c_d_light.png" usemap="#FCDLight_map" border="0" alt=""></center> |
---|
34 | <map name="FCDLight_map"> |
---|
35 | <area href="class_f_c_d_targeted_entity.html" alt="FCDTargetedEntity" shape="rect" coords="0,224,119,248"> |
---|
36 | <area href="class_f_c_d_entity.html" alt="FCDEntity" shape="rect" coords="0,168,119,192"> |
---|
37 | <area href="class_f_c_d_object_with_id.html" alt="FCDObjectWithId" shape="rect" coords="0,112,119,136"> |
---|
38 | <area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,119,80"> |
---|
39 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,119,24"> |
---|
40 | </map> |
---|
41 | <a href="class_f_c_d_light-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
42 | <tr><td></td></tr> |
---|
43 | <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> |
---|
44 | <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60">LightType</a> { <a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60cdd1f5feac88cf971d9edad4126243c5">POINT</a>, |
---|
45 | <a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60aca948f926e7b39611a4f5a4886db8cd">SPOT</a>, |
---|
46 | <a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60bf76b195d4f9db1832f491c0b6223c5e">AMBIENT</a>, |
---|
47 | <a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e6007c34b01d651ace906e59ff728a8112d">DIRECTIONAL</a> |
---|
48 | }</td></tr> |
---|
49 | |
---|
50 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The types of lights supported by this class. <a href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60">More...</a><br></td></tr> |
---|
51 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
52 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#af95e04d9a0fabdd2fa9d0e58884c9da">FCDLight</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr> |
---|
53 | |
---|
54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#af95e04d9a0fabdd2fa9d0e58884c9da"></a><br></td></tr> |
---|
55 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#d61cb4f601f39dedc9d10ff71b23a268">~FCDLight</a> ()</td></tr> |
---|
56 | |
---|
57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not release directly. <a href="#d61cb4f601f39dedc9d10ff71b23a268"></a><br></td></tr> |
---|
58 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#846e07aee92d19dd745a98462a9ffd74">GetType</a> () const </td></tr> |
---|
59 | |
---|
60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the entity type for this class. <a href="#846e07aee92d19dd745a98462a9ffd74"></a><br></td></tr> |
---|
61 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_m_vector3.html">FMVector3</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#3dccf583871cdc610001b0e682be5c30">GetColor</a> ()</td></tr> |
---|
62 | |
---|
63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the base color for the light. <a href="#3dccf583871cdc610001b0e682be5c30"></a><br></td></tr> |
---|
64 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="91cb1bcda652369c066bc58e248ef55c"></a><!-- doxytag: member="FCDLight::GetColor" ref="91cb1bcda652369c066bc58e248ef55c" args="() const " --> |
---|
65 | const <a class="el" href="class_f_m_vector3.html">FMVector3</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#91cb1bcda652369c066bc58e248ef55c">GetColor</a> () const </td></tr> |
---|
66 | |
---|
67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
68 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#e0391538fa3a7e801bf1a67376b99849">SetColor</a> (const <a class="el" href="class_f_m_vector3.html">FMVector3</a> &col)</td></tr> |
---|
69 | |
---|
70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the base color for the light. <a href="#e0391538fa3a7e801bf1a67376b99849"></a><br></td></tr> |
---|
71 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#40bbd892b19faa31092dd816b39986b9">GetIntensity</a> ()</td></tr> |
---|
72 | |
---|
73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the intensity of the light. <a href="#40bbd892b19faa31092dd816b39986b9"></a><br></td></tr> |
---|
74 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0fd99526f320f3aa0d30db0cdf9271b"></a><!-- doxytag: member="FCDLight::GetIntensity" ref="e0fd99526f320f3aa0d30db0cdf9271b" args="() const " --> |
---|
75 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#e0fd99526f320f3aa0d30db0cdf9271b">GetIntensity</a> () const </td></tr> |
---|
76 | |
---|
77 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
78 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#5805489e21bcaa487fe165b1e23c48c9">SetIntensity</a> (float _intensity)</td></tr> |
---|
79 | |
---|
80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the intensity of the light. <a href="#5805489e21bcaa487fe165b1e23c48c9"></a><br></td></tr> |
---|
81 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60">LightType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#a6a7002af06c8663e083390a8497bc88">GetLightType</a> () const </td></tr> |
---|
82 | |
---|
83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of the light. <a href="#a6a7002af06c8663e083390a8497bc88"></a><br></td></tr> |
---|
84 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#f1d0df3b52fd2bc9d19ccc9f7e8f1b2b">SetLightType</a> (<a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60">LightType</a> type)</td></tr> |
---|
85 | |
---|
86 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the type of the light. <a href="#f1d0df3b52fd2bc9d19ccc9f7e8f1b2b"></a><br></td></tr> |
---|
87 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#93baf46fe53050713d2ab0164b171cb3">GetConstantAttenuationFactor</a> ()</td></tr> |
---|
88 | |
---|
89 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the constant attenuation factor for the light. <a href="#93baf46fe53050713d2ab0164b171cb3"></a><br></td></tr> |
---|
90 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dcf8a831190a37ab3212c41b4368444e"></a><!-- doxytag: member="FCDLight::GetConstantAttenuationFactor" ref="dcf8a831190a37ab3212c41b4368444e" args="() const " --> |
---|
91 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#dcf8a831190a37ab3212c41b4368444e">GetConstantAttenuationFactor</a> () const </td></tr> |
---|
92 | |
---|
93 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
94 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#acb2ad42d6e14393e1016866f2fb90fa">SetConstantAttenuationFactor</a> (float factor)</td></tr> |
---|
95 | |
---|
96 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the constant attenuation factor for the light. <a href="#acb2ad42d6e14393e1016866f2fb90fa"></a><br></td></tr> |
---|
97 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#4a106e742942ac5a2965fe928ad2f258">GetLinearAttenuationFactor</a> ()</td></tr> |
---|
98 | |
---|
99 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the linear attenuation factor for the light. <a href="#4a106e742942ac5a2965fe928ad2f258"></a><br></td></tr> |
---|
100 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e4cfc25baf0dcd24cdd2f447317b984"></a><!-- doxytag: member="FCDLight::GetLinearAttenuationFactor" ref="0e4cfc25baf0dcd24cdd2f447317b984" args="() const " --> |
---|
101 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#0e4cfc25baf0dcd24cdd2f447317b984">GetLinearAttenuationFactor</a> () const </td></tr> |
---|
102 | |
---|
103 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
104 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#c49add5d8113667515dbf732f54b074c">SetLinearAttenuationFactor</a> (float factor)</td></tr> |
---|
105 | |
---|
106 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the linear attenuation factor for the light. <a href="#c49add5d8113667515dbf732f54b074c"></a><br></td></tr> |
---|
107 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#a27edb265c1b7cff2fe5a5025686e9c7">GetQuadraticAttenuationFactor</a> ()</td></tr> |
---|
108 | |
---|
109 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the quadratic attenuation factor for the light. <a href="#a27edb265c1b7cff2fe5a5025686e9c7"></a><br></td></tr> |
---|
110 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4bf0589756633c69728170dce565327e"></a><!-- doxytag: member="FCDLight::GetQuadraticAttenuationFactor" ref="4bf0589756633c69728170dce565327e" args="() const " --> |
---|
111 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#4bf0589756633c69728170dce565327e">GetQuadraticAttenuationFactor</a> () const </td></tr> |
---|
112 | |
---|
113 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
114 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#2d399fdd6cb7acb438f4a928bed8990f">SetQuadraticAttenuationFactor</a> (float factor)</td></tr> |
---|
115 | |
---|
116 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the quadratic attenuation factor for the light. <a href="#2d399fdd6cb7acb438f4a928bed8990f"></a><br></td></tr> |
---|
117 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#af51d0f0502a00bcbefcd033ceb42c84">GetFallOffExponent</a> ()</td></tr> |
---|
118 | |
---|
119 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the fall-off exponent for the light. <a href="#af51d0f0502a00bcbefcd033ceb42c84"></a><br></td></tr> |
---|
120 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62182b28b0bea0803b1e21416236a6ae"></a><!-- doxytag: member="FCDLight::GetFallOffExponent" ref="62182b28b0bea0803b1e21416236a6ae" args="() const " --> |
---|
121 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#62182b28b0bea0803b1e21416236a6ae">GetFallOffExponent</a> () const </td></tr> |
---|
122 | |
---|
123 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
124 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#41ef012ce10d686bdd298e125523914c">SetFallOffExponent</a> (float exponent)</td></tr> |
---|
125 | |
---|
126 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the fall-off exponent for the light. <a href="#41ef012ce10d686bdd298e125523914c"></a><br></td></tr> |
---|
127 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#d21c5e4f518a0cf2b9b12e678eae2313">GetFallOffAngle</a> ()</td></tr> |
---|
128 | |
---|
129 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the fall-off angle for the light. <a href="#d21c5e4f518a0cf2b9b12e678eae2313"></a><br></td></tr> |
---|
130 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18e1d577f5bb786fef236c9f0bc8ecd7"></a><!-- doxytag: member="FCDLight::GetFallOffAngle" ref="18e1d577f5bb786fef236c9f0bc8ecd7" args="() const " --> |
---|
131 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#18e1d577f5bb786fef236c9f0bc8ecd7">GetFallOffAngle</a> () const </td></tr> |
---|
132 | |
---|
133 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
134 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#f5ab71bc8463b42473a3d65d5f5a6f53">SetFallOffAngle</a> (float angle)</td></tr> |
---|
135 | |
---|
136 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the fall-off angle for the light. <a href="#f5ab71bc8463b42473a3d65d5f5a6f53"></a><br></td></tr> |
---|
137 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#b39d55f4c016d7d81ca67271fdd78366">GetOuterAngle</a> ()</td></tr> |
---|
138 | |
---|
139 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the outer angle for the light. <a href="#b39d55f4c016d7d81ca67271fdd78366"></a><br></td></tr> |
---|
140 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="976d60e1ad251179b67a823eef20066f"></a><!-- doxytag: member="FCDLight::GetOuterAngle" ref="976d60e1ad251179b67a823eef20066f" args="() const " --> |
---|
141 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#976d60e1ad251179b67a823eef20066f">GetOuterAngle</a> () const </td></tr> |
---|
142 | |
---|
143 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
144 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#dd7a7a1357b00dee19f0a2add3d21818">SetOuterAngle</a> (float angle)</td></tr> |
---|
145 | |
---|
146 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the outer angle for the light. <a href="#dd7a7a1357b00dee19f0a2add3d21818"></a><br></td></tr> |
---|
147 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#4785b823d6f2c48119c0c9472b8b611b">GetPenumbraAngle</a> ()</td></tr> |
---|
148 | |
---|
149 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the penumbra angle for the light. <a href="#4785b823d6f2c48119c0c9472b8b611b"></a><br></td></tr> |
---|
150 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="676712210b5a12bb5f57280dfa6f4a7e"></a><!-- doxytag: member="FCDLight::GetPenumbraAngle" ref="676712210b5a12bb5f57280dfa6f4a7e" args="() const " --> |
---|
151 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#676712210b5a12bb5f57280dfa6f4a7e">GetPenumbraAngle</a> () const </td></tr> |
---|
152 | |
---|
153 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
154 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#4fafa71178c1b0f65ddc40455fc63cb3">SetPenumbraAngle</a> (float angle)</td></tr> |
---|
155 | |
---|
156 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the penumbra angle for the light. <a href="#4fafa71178c1b0f65ddc40455fc63cb3"></a><br></td></tr> |
---|
157 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#8c0ec76c13844f1b1180ffbf0d2b76a9">GetAspectRatio</a> ()</td></tr> |
---|
158 | |
---|
159 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the aspect ratio for the light. <a href="#8c0ec76c13844f1b1180ffbf0d2b76a9"></a><br></td></tr> |
---|
160 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="426a5f9a82802d3198a947726d879560"></a><!-- doxytag: member="FCDLight::GetAspectRatio" ref="426a5f9a82802d3198a947726d879560" args="() const " --> |
---|
161 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#426a5f9a82802d3198a947726d879560">GetAspectRatio</a> () const </td></tr> |
---|
162 | |
---|
163 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
164 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#7ea3d101334b75f7c20bf82133035ad9">SetAspectRatio</a> (float ratio)</td></tr> |
---|
165 | |
---|
166 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the aspect ratio for the light. <a href="#7ea3d101334b75f7c20bf82133035ad9"></a><br></td></tr> |
---|
167 | <tr><td class="memItemLeft" nowrap align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#3d893ac84ff23b088e7bd0243c7f6ed1">GetDropoff</a> ()</td></tr> |
---|
168 | |
---|
169 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the drop-off for the light. <a href="#3d893ac84ff23b088e7bd0243c7f6ed1"></a><br></td></tr> |
---|
170 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c770c3080bb95562a714cc1364b38062"></a><!-- doxytag: member="FCDLight::GetDropoff" ref="c770c3080bb95562a714cc1364b38062" args="() const " --> |
---|
171 | const float & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#c770c3080bb95562a714cc1364b38062">GetDropoff</a> () const </td></tr> |
---|
172 | |
---|
173 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
174 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#78e8a5e5465c92226c41cc93e22652da">SetDropoff</a> (float factor)</td></tr> |
---|
175 | |
---|
176 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the drop-off for the light. <a href="#78e8a5e5465c92226c41cc93e22652da"></a><br></td></tr> |
---|
177 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#8493199542feee7ea18e283f0ebe33bc">DoesOvershoot</a> () const </td></tr> |
---|
178 | |
---|
179 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether the directional light overshoots. <a href="#8493199542feee7ea18e283f0ebe33bc"></a><br></td></tr> |
---|
180 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#106026731aee85fdc770689864f9de7c">SetOvershoot</a> (bool _overshoots)</td></tr> |
---|
181 | |
---|
182 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the directional light overshoots. <a href="#106026731aee85fdc770689864f9de7c"></a><br></td></tr> |
---|
183 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#d35cbe86393f360df9928be24482ba05">LoadFromXML</a> (xmlNode *lightNode)</td></tr> |
---|
184 | |
---|
185 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the <light> element from a given COLLADA XML tree node. <a href="#d35cbe86393f360df9928be24482ba05"></a><br></td></tr> |
---|
186 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual xmlNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_light.html#6bd043e068522f2cc3411d0dfe6feea2">WriteToXML</a> (xmlNode *parentNode) const </td></tr> |
---|
187 | |
---|
188 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the <light> element to the given COLLADA XML tree node. <a href="#6bd043e068522f2cc3411d0dfe6feea2"></a><br></td></tr> |
---|
189 | </table> |
---|
190 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
191 | A COLLADA light. |
---|
192 | <p> |
---|
193 | Based on the <a class="el" href="class_f_c_d_targeted_entity.html">FCDTargetedEntity</a> class to supported aimed lights. COLLADA defines four types of native lights: point, spot, ambient and directional. These four types are fully handled by this class: make sure to check the type flag as well as which information to expect for each light type.<p> |
---|
194 | A COLLADA ambient light has a global color, which should be added to all other lighting on all geometry.<p> |
---|
195 | A COLLADA directional light has a global color, which should be multiplied to the cosine of the angle between the normal vector of a triangle and the direction of the light. Note that the direction will be calculated from the transforms, for each instance, and is not provided by this class.<p> |
---|
196 | A COLLADA point light has a color which attenuates as the distance increases between the light position and the vertex being shaded. Note that the position will be calculated from the transforms, for each instance, and is not provided by this class.<p> |
---|
197 | A COLLADA spot light is a point light which lights only the objects that appear within a specific angle, with respect to the direction of the light. Note that the position and the direction will be calculated from the transforms, for each instance, and is not provided by this class. |
---|
198 | <p> |
---|
199 | <hr><h2>Member Enumeration Documentation</h2> |
---|
200 | <a class="anchor" name="358eac688b4a74aa90531e5206e92e60"></a><!-- doxytag: member="FCDLight::LightType" ref="358eac688b4a74aa90531e5206e92e60" args="" --><p> |
---|
201 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
202 | <tr> |
---|
203 | <td class="mdRow"> |
---|
204 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
205 | <tr> |
---|
206 | <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60">FCDLight::LightType</a> </td> |
---|
207 | </tr> |
---|
208 | </table> |
---|
209 | </td> |
---|
210 | </tr> |
---|
211 | </table> |
---|
212 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
213 | <tr> |
---|
214 | <td> |
---|
215 | |
---|
216 | </td> |
---|
217 | <td> |
---|
218 | |
---|
219 | <p> |
---|
220 | The types of lights supported by this class. |
---|
221 | <p> |
---|
222 | <dl compact><dt><b>Enumerator: </b></dt><dd> |
---|
223 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
224 | <tr><td valign="top"><em><a class="anchor" name="358eac688b4a74aa90531e5206e92e60cdd1f5feac88cf971d9edad4126243c5"></a><!-- doxytag: member="POINT" ref="358eac688b4a74aa90531e5206e92e60cdd1f5feac88cf971d9edad4126243c5" args="" -->POINT</em> </td><td> |
---|
225 | A point light. |
---|
226 | <p> |
---|
227 | This is the default type. </td></tr> |
---|
228 | <tr><td valign="top"><em><a class="anchor" name="358eac688b4a74aa90531e5206e92e60aca948f926e7b39611a4f5a4886db8cd"></a><!-- doxytag: member="SPOT" ref="358eac688b4a74aa90531e5206e92e60aca948f926e7b39611a4f5a4886db8cd" args="" -->SPOT</em> </td><td> |
---|
229 | A spot light. </td></tr> |
---|
230 | <tr><td valign="top"><em><a class="anchor" name="358eac688b4a74aa90531e5206e92e60bf76b195d4f9db1832f491c0b6223c5e"></a><!-- doxytag: member="AMBIENT" ref="358eac688b4a74aa90531e5206e92e60bf76b195d4f9db1832f491c0b6223c5e" args="" -->AMBIENT</em> </td><td> |
---|
231 | An ambient light. </td></tr> |
---|
232 | <tr><td valign="top"><em><a class="anchor" name="358eac688b4a74aa90531e5206e92e6007c34b01d651ace906e59ff728a8112d"></a><!-- doxytag: member="DIRECTIONAL" ref="358eac688b4a74aa90531e5206e92e6007c34b01d651ace906e59ff728a8112d" args="" -->DIRECTIONAL</em> </td><td> |
---|
233 | A directional light. </td></tr> |
---|
234 | </table> |
---|
235 | </dl> |
---|
236 | </td> |
---|
237 | </tr> |
---|
238 | </table> |
---|
239 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
240 | <a class="anchor" name="af95e04d9a0fabdd2fa9d0e58884c9da"></a><!-- doxytag: member="FCDLight::FCDLight" ref="af95e04d9a0fabdd2fa9d0e58884c9da" args="(FCDocument *document)" --><p> |
---|
241 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
242 | <tr> |
---|
243 | <td class="mdRow"> |
---|
244 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
245 | <tr> |
---|
246 | <td class="md" nowrap valign="top">FCDLight::FCDLight </td> |
---|
247 | <td class="md" valign="top">( </td> |
---|
248 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
249 | <td class="mdname1" valign="top" nowrap> <em>document</em> </td> |
---|
250 | <td class="md" valign="top"> ) </td> |
---|
251 | <td class="md" nowrap></td> |
---|
252 | </tr> |
---|
253 | </table> |
---|
254 | </td> |
---|
255 | </tr> |
---|
256 | </table> |
---|
257 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
258 | <tr> |
---|
259 | <td> |
---|
260 | |
---|
261 | </td> |
---|
262 | <td> |
---|
263 | |
---|
264 | <p> |
---|
265 | Constructor: do not use directly. |
---|
266 | <p> |
---|
267 | Create new lights using the <a class="el" href="class_f_c_d_library.html#a5cdcac5a447298d5e3816e4f8c864d0">FCDLibrary::AddEntity</a> function. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
268 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
269 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that contains this light entity. </td></tr> |
---|
270 | </table> |
---|
271 | </dl> |
---|
272 | </td> |
---|
273 | </tr> |
---|
274 | </table> |
---|
275 | <a class="anchor" name="d61cb4f601f39dedc9d10ff71b23a268"></a><!-- doxytag: member="FCDLight::~FCDLight" ref="d61cb4f601f39dedc9d10ff71b23a268" args="()" --><p> |
---|
276 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
277 | <tr> |
---|
278 | <td class="mdRow"> |
---|
279 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
280 | <tr> |
---|
281 | <td class="md" nowrap valign="top">virtual FCDLight::~FCDLight </td> |
---|
282 | <td class="md" valign="top">( </td> |
---|
283 | <td class="mdname1" valign="top" nowrap> </td> |
---|
284 | <td class="md" valign="top"> ) </td> |
---|
285 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
286 | </tr> |
---|
287 | </table> |
---|
288 | </td> |
---|
289 | </tr> |
---|
290 | </table> |
---|
291 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
292 | <tr> |
---|
293 | <td> |
---|
294 | |
---|
295 | </td> |
---|
296 | <td> |
---|
297 | |
---|
298 | <p> |
---|
299 | Destructor: do not release directly. |
---|
300 | <p> |
---|
301 | Release lights using the <a class="el" href="class_f_c_d_library.html#3fbfbcf4ade5b9c94d2ee2f59db5921d">FCDLibrary::ReleaseEntity</a> function. All lights are also released with the document that they belong to. </td> |
---|
302 | </tr> |
---|
303 | </table> |
---|
304 | <hr><h2>Member Function Documentation</h2> |
---|
305 | <a class="anchor" name="8493199542feee7ea18e283f0ebe33bc"></a><!-- doxytag: member="FCDLight::DoesOvershoot" ref="8493199542feee7ea18e283f0ebe33bc" args="() const " --><p> |
---|
306 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
307 | <tr> |
---|
308 | <td class="mdRow"> |
---|
309 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
310 | <tr> |
---|
311 | <td class="md" nowrap valign="top">bool FCDLight::DoesOvershoot </td> |
---|
312 | <td class="md" valign="top">( </td> |
---|
313 | <td class="mdname1" valign="top" nowrap> </td> |
---|
314 | <td class="md" valign="top"> ) </td> |
---|
315 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
316 | </tr> |
---|
317 | </table> |
---|
318 | </td> |
---|
319 | </tr> |
---|
320 | </table> |
---|
321 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
322 | <tr> |
---|
323 | <td> |
---|
324 | |
---|
325 | </td> |
---|
326 | <td> |
---|
327 | |
---|
328 | <p> |
---|
329 | Retrieves whether the directional light overshoots. |
---|
330 | <p> |
---|
331 | This value is only used by documents exported by ColladaMax. This value is valid only for directional lights. This flag represents whether the directional light has a global projection, as defined in COLLADA, or a cylinder/prism projection. Note that there is no way to know if the projection is conic or pyramidal. <dl compact><dt><b>Returns:</b></dt><dd>Whether the directional light overshoots. </dd></dl> |
---|
332 | </td> |
---|
333 | </tr> |
---|
334 | </table> |
---|
335 | <a class="anchor" name="8c0ec76c13844f1b1180ffbf0d2b76a9"></a><!-- doxytag: member="FCDLight::GetAspectRatio" ref="8c0ec76c13844f1b1180ffbf0d2b76a9" args="()" --><p> |
---|
336 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
337 | <tr> |
---|
338 | <td class="mdRow"> |
---|
339 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
340 | <tr> |
---|
341 | <td class="md" nowrap valign="top">float& FCDLight::GetAspectRatio </td> |
---|
342 | <td class="md" valign="top">( </td> |
---|
343 | <td class="mdname1" valign="top" nowrap> </td> |
---|
344 | <td class="md" valign="top"> ) </td> |
---|
345 | <td class="md" nowrap><code> [inline]</code></td> |
---|
346 | </tr> |
---|
347 | </table> |
---|
348 | </td> |
---|
349 | </tr> |
---|
350 | </table> |
---|
351 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
352 | <tr> |
---|
353 | <td> |
---|
354 | |
---|
355 | </td> |
---|
356 | <td> |
---|
357 | |
---|
358 | <p> |
---|
359 | Retrieves the aspect ratio for the light. |
---|
360 | <p> |
---|
361 | This value is only used by documents exported by ColladaMax. This value is valid only for spot lights and directional lights which project a rectangle (for pyramidal projection). It represents the ratio of the projection's height to the projection's width and defines the projection's rectangle. For pyramidal projections, the fall-off and outer angles represent the width of the projection. Note that there is no way to know if the projection is conic or pyramidal. <dl compact><dt><b>Returns:</b></dt><dd>The aspect ratio of the light pyramidal projection. </dd></dl> |
---|
362 | </td> |
---|
363 | </tr> |
---|
364 | </table> |
---|
365 | <a class="anchor" name="3dccf583871cdc610001b0e682be5c30"></a><!-- doxytag: member="FCDLight::GetColor" ref="3dccf583871cdc610001b0e682be5c30" args="()" --><p> |
---|
366 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
367 | <tr> |
---|
368 | <td class="mdRow"> |
---|
369 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
370 | <tr> |
---|
371 | <td class="md" nowrap valign="top"><a class="el" href="class_f_m_vector3.html">FMVector3</a>& FCDLight::GetColor </td> |
---|
372 | <td class="md" valign="top">( </td> |
---|
373 | <td class="mdname1" valign="top" nowrap> </td> |
---|
374 | <td class="md" valign="top"> ) </td> |
---|
375 | <td class="md" nowrap><code> [inline]</code></td> |
---|
376 | </tr> |
---|
377 | </table> |
---|
378 | </td> |
---|
379 | </tr> |
---|
380 | </table> |
---|
381 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
382 | <tr> |
---|
383 | <td> |
---|
384 | |
---|
385 | </td> |
---|
386 | <td> |
---|
387 | |
---|
388 | <p> |
---|
389 | Retrieves the base color for the light. |
---|
390 | <p> |
---|
391 | To calculate the light color, multiply the base color with the intensity. <dl compact><dt><b>Returns:</b></dt><dd>The base color for the light. </dd></dl> |
---|
392 | </td> |
---|
393 | </tr> |
---|
394 | </table> |
---|
395 | <a class="anchor" name="93baf46fe53050713d2ab0164b171cb3"></a><!-- doxytag: member="FCDLight::GetConstantAttenuationFactor" ref="93baf46fe53050713d2ab0164b171cb3" args="()" --><p> |
---|
396 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
397 | <tr> |
---|
398 | <td class="mdRow"> |
---|
399 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
400 | <tr> |
---|
401 | <td class="md" nowrap valign="top">float& FCDLight::GetConstantAttenuationFactor </td> |
---|
402 | <td class="md" valign="top">( </td> |
---|
403 | <td class="mdname1" valign="top" nowrap> </td> |
---|
404 | <td class="md" valign="top"> ) </td> |
---|
405 | <td class="md" nowrap><code> [inline]</code></td> |
---|
406 | </tr> |
---|
407 | </table> |
---|
408 | </td> |
---|
409 | </tr> |
---|
410 | </table> |
---|
411 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
412 | <tr> |
---|
413 | <td> |
---|
414 | |
---|
415 | </td> |
---|
416 | <td> |
---|
417 | |
---|
418 | <p> |
---|
419 | Retrieves the constant attenuation factor for the light. |
---|
420 | <p> |
---|
421 | This value is valid only for point and spot lights. <dl compact><dt><b>Returns:</b></dt><dd>The constant attenuation factor. </dd></dl> |
---|
422 | </td> |
---|
423 | </tr> |
---|
424 | </table> |
---|
425 | <a class="anchor" name="3d893ac84ff23b088e7bd0243c7f6ed1"></a><!-- doxytag: member="FCDLight::GetDropoff" ref="3d893ac84ff23b088e7bd0243c7f6ed1" args="()" --><p> |
---|
426 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
427 | <tr> |
---|
428 | <td class="mdRow"> |
---|
429 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
430 | <tr> |
---|
431 | <td class="md" nowrap valign="top">float& FCDLight::GetDropoff </td> |
---|
432 | <td class="md" valign="top">( </td> |
---|
433 | <td class="mdname1" valign="top" nowrap> </td> |
---|
434 | <td class="md" valign="top"> ) </td> |
---|
435 | <td class="md" nowrap><code> [inline]</code></td> |
---|
436 | </tr> |
---|
437 | </table> |
---|
438 | </td> |
---|
439 | </tr> |
---|
440 | </table> |
---|
441 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
442 | <tr> |
---|
443 | <td> |
---|
444 | |
---|
445 | </td> |
---|
446 | <td> |
---|
447 | |
---|
448 | <p> |
---|
449 | Retrieves the drop-off for the light. |
---|
450 | <p> |
---|
451 | This value is only used by documents exported by ColladaMaya. <dl compact><dt><b>Returns:</b></dt><dd>The drop-off for the light. </dd></dl> |
---|
452 | </td> |
---|
453 | </tr> |
---|
454 | </table> |
---|
455 | <a class="anchor" name="d21c5e4f518a0cf2b9b12e678eae2313"></a><!-- doxytag: member="FCDLight::GetFallOffAngle" ref="d21c5e4f518a0cf2b9b12e678eae2313" args="()" --><p> |
---|
456 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
457 | <tr> |
---|
458 | <td class="mdRow"> |
---|
459 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
460 | <tr> |
---|
461 | <td class="md" nowrap valign="top">float& FCDLight::GetFallOffAngle </td> |
---|
462 | <td class="md" valign="top">( </td> |
---|
463 | <td class="mdname1" valign="top" nowrap> </td> |
---|
464 | <td class="md" valign="top"> ) </td> |
---|
465 | <td class="md" nowrap><code> [inline]</code></td> |
---|
466 | </tr> |
---|
467 | </table> |
---|
468 | </td> |
---|
469 | </tr> |
---|
470 | </table> |
---|
471 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
472 | <tr> |
---|
473 | <td> |
---|
474 | |
---|
475 | </td> |
---|
476 | <td> |
---|
477 | |
---|
478 | <p> |
---|
479 | Retrieves the fall-off angle for the light. |
---|
480 | <p> |
---|
481 | This value is valid only for spot lights. It defines the cone of the spot light. <dl compact><dt><b>Returns:</b></dt><dd>The spot light fall-off angle. </dd></dl> |
---|
482 | </td> |
---|
483 | </tr> |
---|
484 | </table> |
---|
485 | <a class="anchor" name="af51d0f0502a00bcbefcd033ceb42c84"></a><!-- doxytag: member="FCDLight::GetFallOffExponent" ref="af51d0f0502a00bcbefcd033ceb42c84" args="()" --><p> |
---|
486 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
487 | <tr> |
---|
488 | <td class="mdRow"> |
---|
489 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
490 | <tr> |
---|
491 | <td class="md" nowrap valign="top">float& FCDLight::GetFallOffExponent </td> |
---|
492 | <td class="md" valign="top">( </td> |
---|
493 | <td class="mdname1" valign="top" nowrap> </td> |
---|
494 | <td class="md" valign="top"> ) </td> |
---|
495 | <td class="md" nowrap><code> [inline]</code></td> |
---|
496 | </tr> |
---|
497 | </table> |
---|
498 | </td> |
---|
499 | </tr> |
---|
500 | </table> |
---|
501 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
502 | <tr> |
---|
503 | <td> |
---|
504 | |
---|
505 | </td> |
---|
506 | <td> |
---|
507 | |
---|
508 | <p> |
---|
509 | Retrieves the fall-off exponent for the light. |
---|
510 | <p> |
---|
511 | This value is valid only for spot lights. It determines how fast the lighting turns off, with respect to angles greater than the fall-off angle. This results in a smooth lighting at the spot light's edges.<p> |
---|
512 | IMPORTANT NOTE: Neither ColladaMaya or ColladaMax use this value as neither Maya or 3dsMax use this technique for soft lighting.<p> |
---|
513 | <dl compact><dt><b>Returns:</b></dt><dd>The spot light fall-off exponent. </dd></dl> |
---|
514 | </td> |
---|
515 | </tr> |
---|
516 | </table> |
---|
517 | <a class="anchor" name="40bbd892b19faa31092dd816b39986b9"></a><!-- doxytag: member="FCDLight::GetIntensity" ref="40bbd892b19faa31092dd816b39986b9" args="()" --><p> |
---|
518 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
519 | <tr> |
---|
520 | <td class="mdRow"> |
---|
521 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
522 | <tr> |
---|
523 | <td class="md" nowrap valign="top">float& FCDLight::GetIntensity </td> |
---|
524 | <td class="md" valign="top">( </td> |
---|
525 | <td class="mdname1" valign="top" nowrap> </td> |
---|
526 | <td class="md" valign="top"> ) </td> |
---|
527 | <td class="md" nowrap><code> [inline]</code></td> |
---|
528 | </tr> |
---|
529 | </table> |
---|
530 | </td> |
---|
531 | </tr> |
---|
532 | </table> |
---|
533 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
534 | <tr> |
---|
535 | <td> |
---|
536 | |
---|
537 | </td> |
---|
538 | <td> |
---|
539 | |
---|
540 | <p> |
---|
541 | Retrieves the intensity of the light. |
---|
542 | <p> |
---|
543 | To calculate the light color, multiply the base color with the intensity. <dl compact><dt><b>Returns:</b></dt><dd>The intensity of the light. </dd></dl> |
---|
544 | </td> |
---|
545 | </tr> |
---|
546 | </table> |
---|
547 | <a class="anchor" name="a6a7002af06c8663e083390a8497bc88"></a><!-- doxytag: member="FCDLight::GetLightType" ref="a6a7002af06c8663e083390a8497bc88" args="() const " --><p> |
---|
548 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
549 | <tr> |
---|
550 | <td class="mdRow"> |
---|
551 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
552 | <tr> |
---|
553 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60">LightType</a> FCDLight::GetLightType </td> |
---|
554 | <td class="md" valign="top">( </td> |
---|
555 | <td class="mdname1" valign="top" nowrap> </td> |
---|
556 | <td class="md" valign="top"> ) </td> |
---|
557 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
558 | </tr> |
---|
559 | </table> |
---|
560 | </td> |
---|
561 | </tr> |
---|
562 | </table> |
---|
563 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
564 | <tr> |
---|
565 | <td> |
---|
566 | |
---|
567 | </td> |
---|
568 | <td> |
---|
569 | |
---|
570 | <p> |
---|
571 | Retrieves the type of the light. |
---|
572 | <p> |
---|
573 | Make sure to check the type of light before using the values, as some values may not make sense with some types of light. <dl compact><dt><b>Returns:</b></dt><dd>The light type. </dd></dl> |
---|
574 | </td> |
---|
575 | </tr> |
---|
576 | </table> |
---|
577 | <a class="anchor" name="4a106e742942ac5a2965fe928ad2f258"></a><!-- doxytag: member="FCDLight::GetLinearAttenuationFactor" ref="4a106e742942ac5a2965fe928ad2f258" args="()" --><p> |
---|
578 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
579 | <tr> |
---|
580 | <td class="mdRow"> |
---|
581 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
582 | <tr> |
---|
583 | <td class="md" nowrap valign="top">float& FCDLight::GetLinearAttenuationFactor </td> |
---|
584 | <td class="md" valign="top">( </td> |
---|
585 | <td class="mdname1" valign="top" nowrap> </td> |
---|
586 | <td class="md" valign="top"> ) </td> |
---|
587 | <td class="md" nowrap><code> [inline]</code></td> |
---|
588 | </tr> |
---|
589 | </table> |
---|
590 | </td> |
---|
591 | </tr> |
---|
592 | </table> |
---|
593 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
594 | <tr> |
---|
595 | <td> |
---|
596 | |
---|
597 | </td> |
---|
598 | <td> |
---|
599 | |
---|
600 | <p> |
---|
601 | Retrieves the linear attenuation factor for the light. |
---|
602 | <p> |
---|
603 | This value is valid only for point and spot lights. <dl compact><dt><b>Returns:</b></dt><dd>The linear attenuation factor. </dd></dl> |
---|
604 | </td> |
---|
605 | </tr> |
---|
606 | </table> |
---|
607 | <a class="anchor" name="b39d55f4c016d7d81ca67271fdd78366"></a><!-- doxytag: member="FCDLight::GetOuterAngle" ref="b39d55f4c016d7d81ca67271fdd78366" args="()" --><p> |
---|
608 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
609 | <tr> |
---|
610 | <td class="mdRow"> |
---|
611 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
612 | <tr> |
---|
613 | <td class="md" nowrap valign="top">float& FCDLight::GetOuterAngle </td> |
---|
614 | <td class="md" valign="top">( </td> |
---|
615 | <td class="mdname1" valign="top" nowrap> </td> |
---|
616 | <td class="md" valign="top"> ) </td> |
---|
617 | <td class="md" nowrap><code> [inline]</code></td> |
---|
618 | </tr> |
---|
619 | </table> |
---|
620 | </td> |
---|
621 | </tr> |
---|
622 | </table> |
---|
623 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
624 | <tr> |
---|
625 | <td> |
---|
626 | |
---|
627 | </td> |
---|
628 | <td> |
---|
629 | |
---|
630 | <p> |
---|
631 | Retrieves the outer angle for the light. |
---|
632 | <p> |
---|
633 | This value is valid only for spot lights. This value is only used by documents exported by ColladaMax. This value should always be greater than the fall-off angle. It represents the angle at which the lighting is black. All lighting between the fall-off angle and the outer angle is a linear interpolation between the light color and black. <dl compact><dt><b>Returns:</b></dt><dd>The spot light outer angle. </dd></dl> |
---|
634 | </td> |
---|
635 | </tr> |
---|
636 | </table> |
---|
637 | <a class="anchor" name="4785b823d6f2c48119c0c9472b8b611b"></a><!-- doxytag: member="FCDLight::GetPenumbraAngle" ref="4785b823d6f2c48119c0c9472b8b611b" args="()" --><p> |
---|
638 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
639 | <tr> |
---|
640 | <td class="mdRow"> |
---|
641 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
642 | <tr> |
---|
643 | <td class="md" nowrap valign="top">float& FCDLight::GetPenumbraAngle </td> |
---|
644 | <td class="md" valign="top">( </td> |
---|
645 | <td class="mdname1" valign="top" nowrap> </td> |
---|
646 | <td class="md" valign="top"> ) </td> |
---|
647 | <td class="md" nowrap><code> [inline]</code></td> |
---|
648 | </tr> |
---|
649 | </table> |
---|
650 | </td> |
---|
651 | </tr> |
---|
652 | </table> |
---|
653 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
654 | <tr> |
---|
655 | <td> |
---|
656 | |
---|
657 | </td> |
---|
658 | <td> |
---|
659 | |
---|
660 | <p> |
---|
661 | Retrieves the penumbra angle for the light. |
---|
662 | <p> |
---|
663 | This value is valid only for spot lights. The value is only used by documents exported by ColladaMaya. This value is relative to the fall-off angle and may be negative. If this value is positive, it determines the outer angle, as described above. If this value is negative, the fall-off angle is used as the outer angle and the fall-off angle + the penumbra angle is used as the full-lighting angle. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_light.html#b39d55f4c016d7d81ca67271fdd78366">GetOuterAngle</a> </dd></dl> |
---|
664 | <dl compact><dt><b>Returns:</b></dt><dd>The spot light penumbra angle. </dd></dl> |
---|
665 | </td> |
---|
666 | </tr> |
---|
667 | </table> |
---|
668 | <a class="anchor" name="a27edb265c1b7cff2fe5a5025686e9c7"></a><!-- doxytag: member="FCDLight::GetQuadraticAttenuationFactor" ref="a27edb265c1b7cff2fe5a5025686e9c7" args="()" --><p> |
---|
669 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
670 | <tr> |
---|
671 | <td class="mdRow"> |
---|
672 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
673 | <tr> |
---|
674 | <td class="md" nowrap valign="top">float& FCDLight::GetQuadraticAttenuationFactor </td> |
---|
675 | <td class="md" valign="top">( </td> |
---|
676 | <td class="mdname1" valign="top" nowrap> </td> |
---|
677 | <td class="md" valign="top"> ) </td> |
---|
678 | <td class="md" nowrap><code> [inline]</code></td> |
---|
679 | </tr> |
---|
680 | </table> |
---|
681 | </td> |
---|
682 | </tr> |
---|
683 | </table> |
---|
684 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
685 | <tr> |
---|
686 | <td> |
---|
687 | |
---|
688 | </td> |
---|
689 | <td> |
---|
690 | |
---|
691 | <p> |
---|
692 | Retrieves the quadratic attenuation factor for the light. |
---|
693 | <p> |
---|
694 | This value is valid only for point and spot lights. <dl compact><dt><b>Returns:</b></dt><dd>The quadratic attenuation factor. </dd></dl> |
---|
695 | </td> |
---|
696 | </tr> |
---|
697 | </table> |
---|
698 | <a class="anchor" name="846e07aee92d19dd745a98462a9ffd74"></a><!-- doxytag: member="FCDLight::GetType" ref="846e07aee92d19dd745a98462a9ffd74" args="() const " --><p> |
---|
699 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
700 | <tr> |
---|
701 | <td class="mdRow"> |
---|
702 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
703 | <tr> |
---|
704 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a> FCDLight::GetType </td> |
---|
705 | <td class="md" valign="top">( </td> |
---|
706 | <td class="mdname1" valign="top" nowrap> </td> |
---|
707 | <td class="md" valign="top"> ) </td> |
---|
708 | <td class="md" nowrap> const<code> [inline, virtual]</code></td> |
---|
709 | </tr> |
---|
710 | </table> |
---|
711 | </td> |
---|
712 | </tr> |
---|
713 | </table> |
---|
714 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
715 | <tr> |
---|
716 | <td> |
---|
717 | |
---|
718 | </td> |
---|
719 | <td> |
---|
720 | |
---|
721 | <p> |
---|
722 | Retrieves the entity type for this class. |
---|
723 | <p> |
---|
724 | This function is part of the <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> interface. <dl compact><dt><b>Returns:</b></dt><dd>The entity type: LIGHT. </dd></dl> |
---|
725 | |
---|
726 | <p> |
---|
727 | Reimplemented from <a class="el" href="class_f_c_d_entity.html#bfd4312a7124f92364c1e6517c7e60ba">FCDEntity</a>. </td> |
---|
728 | </tr> |
---|
729 | </table> |
---|
730 | <a class="anchor" name="d35cbe86393f360df9928be24482ba05"></a><!-- doxytag: member="FCDLight::LoadFromXML" ref="d35cbe86393f360df9928be24482ba05" args="(xmlNode *lightNode)" --><p> |
---|
731 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
732 | <tr> |
---|
733 | <td class="mdRow"> |
---|
734 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
735 | <tr> |
---|
736 | <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> FCDLight::LoadFromXML </td> |
---|
737 | <td class="md" valign="top">( </td> |
---|
738 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
739 | <td class="mdname1" valign="top" nowrap> <em>lightNode</em> </td> |
---|
740 | <td class="md" valign="top"> ) </td> |
---|
741 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
742 | </tr> |
---|
743 | </table> |
---|
744 | </td> |
---|
745 | </tr> |
---|
746 | </table> |
---|
747 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
748 | <tr> |
---|
749 | <td> |
---|
750 | |
---|
751 | </td> |
---|
752 | <td> |
---|
753 | |
---|
754 | <p> |
---|
755 | [INTERNAL] Reads in the <light> element from a given COLLADA XML tree node. |
---|
756 | <p> |
---|
757 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
758 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
759 | <tr><td valign="top"></td><td valign="top"><em>lightNode</em> </td><td>A COLLADA XML tree node. </td></tr> |
---|
760 | </table> |
---|
761 | </dl> |
---|
762 | <dl compact><dt><b>Returns:</b></dt><dd>The status of the import. If the status is not successful, it may be dangerous to extract information from the light. </dd></dl> |
---|
763 | |
---|
764 | <p> |
---|
765 | Reimplemented from <a class="el" href="class_f_c_d_entity.html#8e32fcc93de76acc4b606db7b5b83890">FCDEntity</a>. </td> |
---|
766 | </tr> |
---|
767 | </table> |
---|
768 | <a class="anchor" name="7ea3d101334b75f7c20bf82133035ad9"></a><!-- doxytag: member="FCDLight::SetAspectRatio" ref="7ea3d101334b75f7c20bf82133035ad9" args="(float ratio)" --><p> |
---|
769 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
770 | <tr> |
---|
771 | <td class="mdRow"> |
---|
772 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
773 | <tr> |
---|
774 | <td class="md" nowrap valign="top">void FCDLight::SetAspectRatio </td> |
---|
775 | <td class="md" valign="top">( </td> |
---|
776 | <td class="md" nowrap valign="top">float </td> |
---|
777 | <td class="mdname1" valign="top" nowrap> <em>ratio</em> </td> |
---|
778 | <td class="md" valign="top"> ) </td> |
---|
779 | <td class="md" nowrap><code> [inline]</code></td> |
---|
780 | </tr> |
---|
781 | </table> |
---|
782 | </td> |
---|
783 | </tr> |
---|
784 | </table> |
---|
785 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
786 | <tr> |
---|
787 | <td> |
---|
788 | |
---|
789 | </td> |
---|
790 | <td> |
---|
791 | |
---|
792 | <p> |
---|
793 | Sets the aspect ratio for the light. |
---|
794 | <p> |
---|
795 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_light.html#8c0ec76c13844f1b1180ffbf0d2b76a9">GetAspectRatio</a> </dd></dl> |
---|
796 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
797 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
798 | <tr><td valign="top"></td><td valign="top"><em>ratio</em> </td><td>The aspect ratio of the light pyramidal projection. </td></tr> |
---|
799 | </table> |
---|
800 | </dl> |
---|
801 | </td> |
---|
802 | </tr> |
---|
803 | </table> |
---|
804 | <a class="anchor" name="e0391538fa3a7e801bf1a67376b99849"></a><!-- doxytag: member="FCDLight::SetColor" ref="e0391538fa3a7e801bf1a67376b99849" args="(const FMVector3 &col)" --><p> |
---|
805 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
806 | <tr> |
---|
807 | <td class="mdRow"> |
---|
808 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
809 | <tr> |
---|
810 | <td class="md" nowrap valign="top">void FCDLight::SetColor </td> |
---|
811 | <td class="md" valign="top">( </td> |
---|
812 | <td class="md" nowrap valign="top">const <a class="el" href="class_f_m_vector3.html">FMVector3</a> & </td> |
---|
813 | <td class="mdname1" valign="top" nowrap> <em>col</em> </td> |
---|
814 | <td class="md" valign="top"> ) </td> |
---|
815 | <td class="md" nowrap><code> [inline]</code></td> |
---|
816 | </tr> |
---|
817 | </table> |
---|
818 | </td> |
---|
819 | </tr> |
---|
820 | </table> |
---|
821 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
822 | <tr> |
---|
823 | <td> |
---|
824 | |
---|
825 | </td> |
---|
826 | <td> |
---|
827 | |
---|
828 | <p> |
---|
829 | Sets the base color for the light. |
---|
830 | <p> |
---|
831 | To calculate the light color, multiply the base color with the intensity. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
832 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
833 | <tr><td valign="top"></td><td valign="top"><em>col</em> </td><td>The base color for the light. </td></tr> |
---|
834 | </table> |
---|
835 | </dl> |
---|
836 | </td> |
---|
837 | </tr> |
---|
838 | </table> |
---|
839 | <a class="anchor" name="acb2ad42d6e14393e1016866f2fb90fa"></a><!-- doxytag: member="FCDLight::SetConstantAttenuationFactor" ref="acb2ad42d6e14393e1016866f2fb90fa" args="(float factor)" --><p> |
---|
840 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
841 | <tr> |
---|
842 | <td class="mdRow"> |
---|
843 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
844 | <tr> |
---|
845 | <td class="md" nowrap valign="top">void FCDLight::SetConstantAttenuationFactor </td> |
---|
846 | <td class="md" valign="top">( </td> |
---|
847 | <td class="md" nowrap valign="top">float </td> |
---|
848 | <td class="mdname1" valign="top" nowrap> <em>factor</em> </td> |
---|
849 | <td class="md" valign="top"> ) </td> |
---|
850 | <td class="md" nowrap><code> [inline]</code></td> |
---|
851 | </tr> |
---|
852 | </table> |
---|
853 | </td> |
---|
854 | </tr> |
---|
855 | </table> |
---|
856 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
857 | <tr> |
---|
858 | <td> |
---|
859 | |
---|
860 | </td> |
---|
861 | <td> |
---|
862 | |
---|
863 | <p> |
---|
864 | Sets the constant attenuation factor for the light. |
---|
865 | <p> |
---|
866 | This value is valid only for point and spot lights. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
867 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
868 | <tr><td valign="top"></td><td valign="top"><em>factor</em> </td><td>The constant attenuation factor. </td></tr> |
---|
869 | </table> |
---|
870 | </dl> |
---|
871 | </td> |
---|
872 | </tr> |
---|
873 | </table> |
---|
874 | <a class="anchor" name="78e8a5e5465c92226c41cc93e22652da"></a><!-- doxytag: member="FCDLight::SetDropoff" ref="78e8a5e5465c92226c41cc93e22652da" args="(float factor)" --><p> |
---|
875 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
876 | <tr> |
---|
877 | <td class="mdRow"> |
---|
878 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
879 | <tr> |
---|
880 | <td class="md" nowrap valign="top">void FCDLight::SetDropoff </td> |
---|
881 | <td class="md" valign="top">( </td> |
---|
882 | <td class="md" nowrap valign="top">float </td> |
---|
883 | <td class="mdname1" valign="top" nowrap> <em>factor</em> </td> |
---|
884 | <td class="md" valign="top"> ) </td> |
---|
885 | <td class="md" nowrap><code> [inline]</code></td> |
---|
886 | </tr> |
---|
887 | </table> |
---|
888 | </td> |
---|
889 | </tr> |
---|
890 | </table> |
---|
891 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
892 | <tr> |
---|
893 | <td> |
---|
894 | |
---|
895 | </td> |
---|
896 | <td> |
---|
897 | |
---|
898 | <p> |
---|
899 | Sets the drop-off for the light. |
---|
900 | <p> |
---|
901 | This value is only used by documents exported by ColladaMaya. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
902 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
903 | <tr><td valign="top"></td><td valign="top"><em>factor</em> </td><td>The drop-off for the light. </td></tr> |
---|
904 | </table> |
---|
905 | </dl> |
---|
906 | </td> |
---|
907 | </tr> |
---|
908 | </table> |
---|
909 | <a class="anchor" name="f5ab71bc8463b42473a3d65d5f5a6f53"></a><!-- doxytag: member="FCDLight::SetFallOffAngle" ref="f5ab71bc8463b42473a3d65d5f5a6f53" args="(float angle)" --><p> |
---|
910 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
911 | <tr> |
---|
912 | <td class="mdRow"> |
---|
913 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
914 | <tr> |
---|
915 | <td class="md" nowrap valign="top">void FCDLight::SetFallOffAngle </td> |
---|
916 | <td class="md" valign="top">( </td> |
---|
917 | <td class="md" nowrap valign="top">float </td> |
---|
918 | <td class="mdname1" valign="top" nowrap> <em>angle</em> </td> |
---|
919 | <td class="md" valign="top"> ) </td> |
---|
920 | <td class="md" nowrap><code> [inline]</code></td> |
---|
921 | </tr> |
---|
922 | </table> |
---|
923 | </td> |
---|
924 | </tr> |
---|
925 | </table> |
---|
926 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
927 | <tr> |
---|
928 | <td> |
---|
929 | |
---|
930 | </td> |
---|
931 | <td> |
---|
932 | |
---|
933 | <p> |
---|
934 | Sets the fall-off angle for the light. |
---|
935 | <p> |
---|
936 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_light.html#d21c5e4f518a0cf2b9b12e678eae2313">GetFallOffAngle</a> </dd></dl> |
---|
937 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
938 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
939 | <tr><td valign="top"></td><td valign="top"><em>angle</em> </td><td>The spot light fall-off angle. </td></tr> |
---|
940 | </table> |
---|
941 | </dl> |
---|
942 | </td> |
---|
943 | </tr> |
---|
944 | </table> |
---|
945 | <a class="anchor" name="41ef012ce10d686bdd298e125523914c"></a><!-- doxytag: member="FCDLight::SetFallOffExponent" ref="41ef012ce10d686bdd298e125523914c" args="(float exponent)" --><p> |
---|
946 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
947 | <tr> |
---|
948 | <td class="mdRow"> |
---|
949 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
950 | <tr> |
---|
951 | <td class="md" nowrap valign="top">void FCDLight::SetFallOffExponent </td> |
---|
952 | <td class="md" valign="top">( </td> |
---|
953 | <td class="md" nowrap valign="top">float </td> |
---|
954 | <td class="mdname1" valign="top" nowrap> <em>exponent</em> </td> |
---|
955 | <td class="md" valign="top"> ) </td> |
---|
956 | <td class="md" nowrap><code> [inline]</code></td> |
---|
957 | </tr> |
---|
958 | </table> |
---|
959 | </td> |
---|
960 | </tr> |
---|
961 | </table> |
---|
962 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
963 | <tr> |
---|
964 | <td> |
---|
965 | |
---|
966 | </td> |
---|
967 | <td> |
---|
968 | |
---|
969 | <p> |
---|
970 | Sets the fall-off exponent for the light. |
---|
971 | <p> |
---|
972 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_light.html#af51d0f0502a00bcbefcd033ceb42c84">GetFallOffExponent</a> </dd></dl> |
---|
973 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
974 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
975 | <tr><td valign="top"></td><td valign="top"><em>exponent</em> </td><td>The spot light fall-off exponent. </td></tr> |
---|
976 | </table> |
---|
977 | </dl> |
---|
978 | </td> |
---|
979 | </tr> |
---|
980 | </table> |
---|
981 | <a class="anchor" name="5805489e21bcaa487fe165b1e23c48c9"></a><!-- doxytag: member="FCDLight::SetIntensity" ref="5805489e21bcaa487fe165b1e23c48c9" args="(float _intensity)" --><p> |
---|
982 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
983 | <tr> |
---|
984 | <td class="mdRow"> |
---|
985 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
986 | <tr> |
---|
987 | <td class="md" nowrap valign="top">void FCDLight::SetIntensity </td> |
---|
988 | <td class="md" valign="top">( </td> |
---|
989 | <td class="md" nowrap valign="top">float </td> |
---|
990 | <td class="mdname1" valign="top" nowrap> <em>_intensity</em> </td> |
---|
991 | <td class="md" valign="top"> ) </td> |
---|
992 | <td class="md" nowrap><code> [inline]</code></td> |
---|
993 | </tr> |
---|
994 | </table> |
---|
995 | </td> |
---|
996 | </tr> |
---|
997 | </table> |
---|
998 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
999 | <tr> |
---|
1000 | <td> |
---|
1001 | |
---|
1002 | </td> |
---|
1003 | <td> |
---|
1004 | |
---|
1005 | <p> |
---|
1006 | Sets the intensity of the light. |
---|
1007 | <p> |
---|
1008 | To calculate the light color, multiply the base color with the intensity. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1009 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1010 | <tr><td valign="top"></td><td valign="top"><em>_intensity</em> </td><td>The intensity of the light. </td></tr> |
---|
1011 | </table> |
---|
1012 | </dl> |
---|
1013 | </td> |
---|
1014 | </tr> |
---|
1015 | </table> |
---|
1016 | <a class="anchor" name="f1d0df3b52fd2bc9d19ccc9f7e8f1b2b"></a><!-- doxytag: member="FCDLight::SetLightType" ref="f1d0df3b52fd2bc9d19ccc9f7e8f1b2b" args="(LightType type)" --><p> |
---|
1017 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
1018 | <tr> |
---|
1019 | <td class="mdRow"> |
---|
1020 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1021 | <tr> |
---|
1022 | <td class="md" nowrap valign="top">void FCDLight::SetLightType </td> |
---|
1023 | <td class="md" valign="top">( </td> |
---|
1024 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_light.html#358eac688b4a74aa90531e5206e92e60">LightType</a> </td> |
---|
1025 | <td class="mdname1" valign="top" nowrap> <em>type</em> </td> |
---|
1026 | <td class="md" valign="top"> ) </td> |
---|
1027 | <td class="md" nowrap><code> [inline]</code></td> |
---|
1028 | </tr> |
---|
1029 | </table> |
---|
1030 | </td> |
---|
1031 | </tr> |
---|
1032 | </table> |
---|
1033 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
1034 | <tr> |
---|
1035 | <td> |
---|
1036 | |
---|
1037 | </td> |
---|
1038 | <td> |
---|
1039 | |
---|
1040 | <p> |
---|
1041 | Sets the type of the light. |
---|
1042 | <p> |
---|
1043 | The default type of a new light is POINT. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1044 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1045 | <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The light type. </td></tr> |
---|
1046 | </table> |
---|
1047 | </dl> |
---|
1048 | </td> |
---|
1049 | </tr> |
---|
1050 | </table> |
---|
1051 | <a class="anchor" name="c49add5d8113667515dbf732f54b074c"></a><!-- doxytag: member="FCDLight::SetLinearAttenuationFactor" ref="c49add5d8113667515dbf732f54b074c" args="(float factor)" --><p> |
---|
1052 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
1053 | <tr> |
---|
1054 | <td class="mdRow"> |
---|
1055 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1056 | <tr> |
---|
1057 | <td class="md" nowrap valign="top">void FCDLight::SetLinearAttenuationFactor </td> |
---|
1058 | <td class="md" valign="top">( </td> |
---|
1059 | <td class="md" nowrap valign="top">float </td> |
---|
1060 | <td class="mdname1" valign="top" nowrap> <em>factor</em> </td> |
---|
1061 | <td class="md" valign="top"> ) </td> |
---|
1062 | <td class="md" nowrap><code> [inline]</code></td> |
---|
1063 | </tr> |
---|
1064 | </table> |
---|
1065 | </td> |
---|
1066 | </tr> |
---|
1067 | </table> |
---|
1068 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
1069 | <tr> |
---|
1070 | <td> |
---|
1071 | |
---|
1072 | </td> |
---|
1073 | <td> |
---|
1074 | |
---|
1075 | <p> |
---|
1076 | Sets the linear attenuation factor for the light. |
---|
1077 | <p> |
---|
1078 | This value is valid only for point and spot lights. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1079 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1080 | <tr><td valign="top"></td><td valign="top"><em>factor</em> </td><td>The linear attenuation factor. </td></tr> |
---|
1081 | </table> |
---|
1082 | </dl> |
---|
1083 | </td> |
---|
1084 | </tr> |
---|
1085 | </table> |
---|
1086 | <a class="anchor" name="dd7a7a1357b00dee19f0a2add3d21818"></a><!-- doxytag: member="FCDLight::SetOuterAngle" ref="dd7a7a1357b00dee19f0a2add3d21818" args="(float angle)" --><p> |
---|
1087 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
1088 | <tr> |
---|
1089 | <td class="mdRow"> |
---|
1090 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1091 | <tr> |
---|
1092 | <td class="md" nowrap valign="top">void FCDLight::SetOuterAngle </td> |
---|
1093 | <td class="md" valign="top">( </td> |
---|
1094 | <td class="md" nowrap valign="top">float </td> |
---|
1095 | <td class="mdname1" valign="top" nowrap> <em>angle</em> </td> |
---|
1096 | <td class="md" valign="top"> ) </td> |
---|
1097 | <td class="md" nowrap><code> [inline]</code></td> |
---|
1098 | </tr> |
---|
1099 | </table> |
---|
1100 | </td> |
---|
1101 | </tr> |
---|
1102 | </table> |
---|
1103 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
1104 | <tr> |
---|
1105 | <td> |
---|
1106 | |
---|
1107 | </td> |
---|
1108 | <td> |
---|
1109 | |
---|
1110 | <p> |
---|
1111 | Sets the outer angle for the light. |
---|
1112 | <p> |
---|
1113 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_light.html#b39d55f4c016d7d81ca67271fdd78366">GetOuterAngle</a> </dd></dl> |
---|
1114 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1115 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1116 | <tr><td valign="top"></td><td valign="top"><em>angle</em> </td><td>The spot light outer angle. </td></tr> |
---|
1117 | </table> |
---|
1118 | </dl> |
---|
1119 | </td> |
---|
1120 | </tr> |
---|
1121 | </table> |
---|
1122 | <a class="anchor" name="106026731aee85fdc770689864f9de7c"></a><!-- doxytag: member="FCDLight::SetOvershoot" ref="106026731aee85fdc770689864f9de7c" args="(bool _overshoots)" --><p> |
---|
1123 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
1124 | <tr> |
---|
1125 | <td class="mdRow"> |
---|
1126 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1127 | <tr> |
---|
1128 | <td class="md" nowrap valign="top">void FCDLight::SetOvershoot </td> |
---|
1129 | <td class="md" valign="top">( </td> |
---|
1130 | <td class="md" nowrap valign="top">bool </td> |
---|
1131 | <td class="mdname1" valign="top" nowrap> <em>_overshoots</em> </td> |
---|
1132 | <td class="md" valign="top"> ) </td> |
---|
1133 | <td class="md" nowrap><code> [inline]</code></td> |
---|
1134 | </tr> |
---|
1135 | </table> |
---|
1136 | </td> |
---|
1137 | </tr> |
---|
1138 | </table> |
---|
1139 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
1140 | <tr> |
---|
1141 | <td> |
---|
1142 | |
---|
1143 | </td> |
---|
1144 | <td> |
---|
1145 | |
---|
1146 | <p> |
---|
1147 | Sets whether the directional light overshoots. |
---|
1148 | <p> |
---|
1149 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_light.html#8493199542feee7ea18e283f0ebe33bc">DoesOvershoot</a> </dd></dl> |
---|
1150 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1151 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1152 | <tr><td valign="top"></td><td valign="top"><em>_overshoots</em> </td><td>The overshoot flag for the directional light. </td></tr> |
---|
1153 | </table> |
---|
1154 | </dl> |
---|
1155 | </td> |
---|
1156 | </tr> |
---|
1157 | </table> |
---|
1158 | <a class="anchor" name="4fafa71178c1b0f65ddc40455fc63cb3"></a><!-- doxytag: member="FCDLight::SetPenumbraAngle" ref="4fafa71178c1b0f65ddc40455fc63cb3" args="(float angle)" --><p> |
---|
1159 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
1160 | <tr> |
---|
1161 | <td class="mdRow"> |
---|
1162 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1163 | <tr> |
---|
1164 | <td class="md" nowrap valign="top">void FCDLight::SetPenumbraAngle </td> |
---|
1165 | <td class="md" valign="top">( </td> |
---|
1166 | <td class="md" nowrap valign="top">float </td> |
---|
1167 | <td class="mdname1" valign="top" nowrap> <em>angle</em> </td> |
---|
1168 | <td class="md" valign="top"> ) </td> |
---|
1169 | <td class="md" nowrap><code> [inline]</code></td> |
---|
1170 | </tr> |
---|
1171 | </table> |
---|
1172 | </td> |
---|
1173 | </tr> |
---|
1174 | </table> |
---|
1175 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
1176 | <tr> |
---|
1177 | <td> |
---|
1178 | |
---|
1179 | </td> |
---|
1180 | <td> |
---|
1181 | |
---|
1182 | <p> |
---|
1183 | Sets the penumbra angle for the light. |
---|
1184 | <p> |
---|
1185 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_light.html#4785b823d6f2c48119c0c9472b8b611b">GetPenumbraAngle</a> </dd></dl> |
---|
1186 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1187 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1188 | <tr><td valign="top"></td><td valign="top"><em>angle</em> </td><td>The spot light penumbra angle. </td></tr> |
---|
1189 | </table> |
---|
1190 | </dl> |
---|
1191 | </td> |
---|
1192 | </tr> |
---|
1193 | </table> |
---|
1194 | <a class="anchor" name="2d399fdd6cb7acb438f4a928bed8990f"></a><!-- doxytag: member="FCDLight::SetQuadraticAttenuationFactor" ref="2d399fdd6cb7acb438f4a928bed8990f" args="(float factor)" --><p> |
---|
1195 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
1196 | <tr> |
---|
1197 | <td class="mdRow"> |
---|
1198 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1199 | <tr> |
---|
1200 | <td class="md" nowrap valign="top">void FCDLight::SetQuadraticAttenuationFactor </td> |
---|
1201 | <td class="md" valign="top">( </td> |
---|
1202 | <td class="md" nowrap valign="top">float </td> |
---|
1203 | <td class="mdname1" valign="top" nowrap> <em>factor</em> </td> |
---|
1204 | <td class="md" valign="top"> ) </td> |
---|
1205 | <td class="md" nowrap><code> [inline]</code></td> |
---|
1206 | </tr> |
---|
1207 | </table> |
---|
1208 | </td> |
---|
1209 | </tr> |
---|
1210 | </table> |
---|
1211 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
1212 | <tr> |
---|
1213 | <td> |
---|
1214 | |
---|
1215 | </td> |
---|
1216 | <td> |
---|
1217 | |
---|
1218 | <p> |
---|
1219 | Sets the quadratic attenuation factor for the light. |
---|
1220 | <p> |
---|
1221 | This value is valid only for point and spot lights. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1222 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1223 | <tr><td valign="top"></td><td valign="top"><em>factor</em> </td><td>The quadratic attenuation factor. </td></tr> |
---|
1224 | </table> |
---|
1225 | </dl> |
---|
1226 | </td> |
---|
1227 | </tr> |
---|
1228 | </table> |
---|
1229 | <a class="anchor" name="6bd043e068522f2cc3411d0dfe6feea2"></a><!-- doxytag: member="FCDLight::WriteToXML" ref="6bd043e068522f2cc3411d0dfe6feea2" args="(xmlNode *parentNode) const " --><p> |
---|
1230 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
1231 | <tr> |
---|
1232 | <td class="mdRow"> |
---|
1233 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
1234 | <tr> |
---|
1235 | <td class="md" nowrap valign="top">virtual xmlNode* FCDLight::WriteToXML </td> |
---|
1236 | <td class="md" valign="top">( </td> |
---|
1237 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
1238 | <td class="mdname1" valign="top" nowrap> <em>parentNode</em> </td> |
---|
1239 | <td class="md" valign="top"> ) </td> |
---|
1240 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
1241 | </tr> |
---|
1242 | </table> |
---|
1243 | </td> |
---|
1244 | </tr> |
---|
1245 | </table> |
---|
1246 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
1247 | <tr> |
---|
1248 | <td> |
---|
1249 | |
---|
1250 | </td> |
---|
1251 | <td> |
---|
1252 | |
---|
1253 | <p> |
---|
1254 | [INTERNAL] Writes out the <light> element to the given COLLADA XML tree node. |
---|
1255 | <p> |
---|
1256 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
1257 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
1258 | <tr><td valign="top"></td><td valign="top"><em>parentNode</em> </td><td>The COLLADA XML parent node in which to insert the geometry information. </td></tr> |
---|
1259 | </table> |
---|
1260 | </dl> |
---|
1261 | <dl compact><dt><b>Returns:</b></dt><dd>The created XML tree node. </dd></dl> |
---|
1262 | |
---|
1263 | <p> |
---|
1264 | Reimplemented from <a class="el" href="class_f_c_d_entity.html#b27f0c175c3f8fd7064cde48bcf1d7a0">FCDEntity</a>. </td> |
---|
1265 | </tr> |
---|
1266 | </table> |
---|
1267 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
1268 | <li>FCDocument/<a class="el" href="_f_c_d_light_8h-source.html">FCDLight.h</a></ul> |
---|
1269 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by |
---|
1270 | <a href="http://www.doxygen.org/index.html"> |
---|
1271 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
1272 | </body> |
---|
1273 | </html> |
---|