[964] | 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: FCDImage 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>FCDImage Class Reference<br> |
---|
| 25 | <small> |
---|
| 26 | [<a class="el" href="group___f_c_d_effect.html">COLLADA Effect Classes [ColladaFX]</a>]</small> |
---|
| 27 | </h1><!-- doxytag: class="FCDImage" --><!-- doxytag: inherits="FCDEntity" -->A COLLADA image. |
---|
| 28 | <a href="#_details">More...</a> |
---|
| 29 | <p> |
---|
| 30 | <code>#include <<a class="el" href="_f_c_d_image_8h-source.html">FCDImage.h</a>></code> |
---|
| 31 | <p> |
---|
| 32 | <p>Inheritance diagram for FCDImage: |
---|
| 33 | <p><center><img src="class_f_c_d_image.png" usemap="#FCDImage_map" border="0" alt=""></center> |
---|
| 34 | <map name="FCDImage_map"> |
---|
| 35 | <area href="class_f_c_d_entity.html" alt="FCDEntity" shape="rect" coords="0,168,109,192"> |
---|
| 36 | <area href="class_f_c_d_object_with_id.html" alt="FCDObjectWithId" shape="rect" coords="0,112,109,136"> |
---|
| 37 | <area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,109,80"> |
---|
| 38 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,109,24"> |
---|
| 39 | </map> |
---|
| 40 | <a href="class_f_c_d_image-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
| 41 | <tr><td></td></tr> |
---|
| 42 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 43 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#d5beb271aca9f1d566f0370dd06df0e0">FCDImage</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr> |
---|
| 44 | |
---|
| 45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#d5beb271aca9f1d566f0370dd06df0e0"></a><br></td></tr> |
---|
| 46 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#f6a6b97a4723a18d375afbd6596a565a">~FCDImage</a> ()</td></tr> |
---|
| 47 | |
---|
| 48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not use directly. <a href="#f6a6b97a4723a18d375afbd6596a565a"></a><br></td></tr> |
---|
| 49 | <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_image.html#137caaacfc6ee0f82a4f654e142f23ea">GetType</a> () const </td></tr> |
---|
| 50 | |
---|
| 51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the entity type for this class. <a href="#137caaacfc6ee0f82a4f654e142f23ea"></a><br></td></tr> |
---|
| 52 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const fstring & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#6858c945bf5d58a4ce59162bdab1875a">GetFilename</a> () const </td></tr> |
---|
| 53 | |
---|
| 54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the filename of the image file. <a href="#6858c945bf5d58a4ce59162bdab1875a"></a><br></td></tr> |
---|
| 55 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#9489bc2214865330b82029f949ceedf7">SetFilename</a> (const fstring &_filename)</td></tr> |
---|
| 56 | |
---|
| 57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the filename of the image file. <a href="#9489bc2214865330b82029f949ceedf7"></a><br></td></tr> |
---|
| 58 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32 & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#9ff868bc5bcf26c3c861844522dd93d9">GetWidth</a> () const </td></tr> |
---|
| 59 | |
---|
| 60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the width of the image. <a href="#9ff868bc5bcf26c3c861844522dd93d9"></a><br></td></tr> |
---|
| 61 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#1b095ed4b987f695fc4b742d4c4cfb5e">SetWidth</a> (uint32 _width)</td></tr> |
---|
| 62 | |
---|
| 63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the width of the image. <a href="#1b095ed4b987f695fc4b742d4c4cfb5e"></a><br></td></tr> |
---|
| 64 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32 & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#d39e605dd085356561da4b407434a6ba">GetHeight</a> () const </td></tr> |
---|
| 65 | |
---|
| 66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the height of the image. <a href="#d39e605dd085356561da4b407434a6ba"></a><br></td></tr> |
---|
| 67 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#ff423a44ea5f473505efc3e35773e980">SetHeight</a> (uint32 _height)</td></tr> |
---|
| 68 | |
---|
| 69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the height of the image. <a href="#ff423a44ea5f473505efc3e35773e980"></a><br></td></tr> |
---|
| 70 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32 & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#120503567eb788e5000a4d19bfd46f16">GetDepth</a> () const </td></tr> |
---|
| 71 | |
---|
| 72 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the depth of the 3D image. <a href="#120503567eb788e5000a4d19bfd46f16"></a><br></td></tr> |
---|
| 73 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_image.html#bb4f63a3f2e886ad6bacb9be0ebab2d5">SetDepth</a> (uint32 _depth)</td></tr> |
---|
| 74 | |
---|
| 75 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the depth of the 3D image. <a href="#bb4f63a3f2e886ad6bacb9be0ebab2d5"></a><br></td></tr> |
---|
| 76 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <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_image.html#99c1724e2dd75e6d877951e95ffebdc4">LoadFromXML</a> (xmlNode *imageNode)</td></tr> |
---|
| 77 | |
---|
| 78 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the <image> element from a given COLLADA XML tree node. <a href="#99c1724e2dd75e6d877951e95ffebdc4"></a><br></td></tr> |
---|
| 79 | <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_image.html#d894beaf27b521c96e5bbe982ab7e2f2">WriteToXML</a> (xmlNode *parentNode) const </td></tr> |
---|
| 80 | |
---|
| 81 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the <image> element to the given COLLADA XML tree node. <a href="#d894beaf27b521c96e5bbe982ab7e2f2"></a><br></td></tr> |
---|
| 82 | </table> |
---|
| 83 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 84 | A COLLADA image. |
---|
| 85 | <p> |
---|
| 86 | A COLLADA image encapsulates an image file and are contained within the image library. <a class="el" href="namespace_f_collada.html">FCollada</a> doesn't support inlined image bits.<p> |
---|
| 87 | An image is solely defined by its filename. For some image types and optionally, the width, height and depth of the image may be required and valid. |
---|
| 88 | <p> |
---|
| 89 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 90 | <a class="anchor" name="d5beb271aca9f1d566f0370dd06df0e0"></a><!-- doxytag: member="FCDImage::FCDImage" ref="d5beb271aca9f1d566f0370dd06df0e0" args="(FCDocument *document)" --><p> |
---|
| 91 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 92 | <tr> |
---|
| 93 | <td class="mdRow"> |
---|
| 94 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 95 | <tr> |
---|
| 96 | <td class="md" nowrap valign="top">FCDImage::FCDImage </td> |
---|
| 97 | <td class="md" valign="top">( </td> |
---|
| 98 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
| 99 | <td class="mdname1" valign="top" nowrap> <em>document</em> </td> |
---|
| 100 | <td class="md" valign="top"> ) </td> |
---|
| 101 | <td class="md" nowrap></td> |
---|
| 102 | </tr> |
---|
| 103 | </table> |
---|
| 104 | </td> |
---|
| 105 | </tr> |
---|
| 106 | </table> |
---|
| 107 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 108 | <tr> |
---|
| 109 | <td> |
---|
| 110 | |
---|
| 111 | </td> |
---|
| 112 | <td> |
---|
| 113 | |
---|
| 114 | <p> |
---|
| 115 | Constructor: do not use directly. |
---|
| 116 | <p> |
---|
| 117 | Instead, use the <a class="el" href="class_f_c_d_library.html#a5cdcac5a447298d5e3816e4f8c864d0">FCDLibrary::AddEntity</a> function. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 118 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 119 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that owns the image. </td></tr> |
---|
| 120 | </table> |
---|
| 121 | </dl> |
---|
| 122 | </td> |
---|
| 123 | </tr> |
---|
| 124 | </table> |
---|
| 125 | <a class="anchor" name="f6a6b97a4723a18d375afbd6596a565a"></a><!-- doxytag: member="FCDImage::~FCDImage" ref="f6a6b97a4723a18d375afbd6596a565a" args="()" --><p> |
---|
| 126 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 127 | <tr> |
---|
| 128 | <td class="mdRow"> |
---|
| 129 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 130 | <tr> |
---|
| 131 | <td class="md" nowrap valign="top">virtual FCDImage::~FCDImage </td> |
---|
| 132 | <td class="md" valign="top">( </td> |
---|
| 133 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 134 | <td class="md" valign="top"> ) </td> |
---|
| 135 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 136 | </tr> |
---|
| 137 | </table> |
---|
| 138 | </td> |
---|
| 139 | </tr> |
---|
| 140 | </table> |
---|
| 141 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 142 | <tr> |
---|
| 143 | <td> |
---|
| 144 | |
---|
| 145 | </td> |
---|
| 146 | <td> |
---|
| 147 | |
---|
| 148 | <p> |
---|
| 149 | Destructor: do not use directly. |
---|
| 150 | <p> |
---|
| 151 | Instead, use the <a class="el" href="class_f_c_d_library.html#3fbfbcf4ade5b9c94d2ee2f59db5921d">FCDLibrary::ReleaseEntity</a> function. </td> |
---|
| 152 | </tr> |
---|
| 153 | </table> |
---|
| 154 | <hr><h2>Member Function Documentation</h2> |
---|
| 155 | <a class="anchor" name="120503567eb788e5000a4d19bfd46f16"></a><!-- doxytag: member="FCDImage::GetDepth" ref="120503567eb788e5000a4d19bfd46f16" args="() const " --><p> |
---|
| 156 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 157 | <tr> |
---|
| 158 | <td class="mdRow"> |
---|
| 159 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 160 | <tr> |
---|
| 161 | <td class="md" nowrap valign="top">const uint32& FCDImage::GetDepth </td> |
---|
| 162 | <td class="md" valign="top">( </td> |
---|
| 163 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 164 | <td class="md" valign="top"> ) </td> |
---|
| 165 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 166 | </tr> |
---|
| 167 | </table> |
---|
| 168 | </td> |
---|
| 169 | </tr> |
---|
| 170 | </table> |
---|
| 171 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 172 | <tr> |
---|
| 173 | <td> |
---|
| 174 | |
---|
| 175 | </td> |
---|
| 176 | <td> |
---|
| 177 | |
---|
| 178 | <p> |
---|
| 179 | Retrieves the depth of the 3D image. |
---|
| 180 | <p> |
---|
| 181 | This parameter is optional for texture image files. <dl compact><dt><b>Returns:</b></dt><dd>The depth of the image. This value will be zero to indicate that you should retrieve the depth of the image from the image file. </dd></dl> |
---|
| 182 | </td> |
---|
| 183 | </tr> |
---|
| 184 | </table> |
---|
| 185 | <a class="anchor" name="6858c945bf5d58a4ce59162bdab1875a"></a><!-- doxytag: member="FCDImage::GetFilename" ref="6858c945bf5d58a4ce59162bdab1875a" args="() const " --><p> |
---|
| 186 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 187 | <tr> |
---|
| 188 | <td class="mdRow"> |
---|
| 189 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 190 | <tr> |
---|
| 191 | <td class="md" nowrap valign="top">const fstring& FCDImage::GetFilename </td> |
---|
| 192 | <td class="md" valign="top">( </td> |
---|
| 193 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 194 | <td class="md" valign="top"> ) </td> |
---|
| 195 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 196 | </tr> |
---|
| 197 | </table> |
---|
| 198 | </td> |
---|
| 199 | </tr> |
---|
| 200 | </table> |
---|
| 201 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 202 | <tr> |
---|
| 203 | <td> |
---|
| 204 | |
---|
| 205 | </td> |
---|
| 206 | <td> |
---|
| 207 | |
---|
| 208 | <p> |
---|
| 209 | Retrieves the filename of the image file. |
---|
| 210 | <p> |
---|
| 211 | This is the image file that you should load when attempting to use the image bits. <a class="el" href="namespace_f_collada.html">FCollada</a> will deal with the filename internally and provide an absolute filename. <dl compact><dt><b>Returns:</b></dt><dd>The filename of the image file. </dd></dl> |
---|
| 212 | </td> |
---|
| 213 | </tr> |
---|
| 214 | </table> |
---|
| 215 | <a class="anchor" name="d39e605dd085356561da4b407434a6ba"></a><!-- doxytag: member="FCDImage::GetHeight" ref="d39e605dd085356561da4b407434a6ba" args="() const " --><p> |
---|
| 216 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 217 | <tr> |
---|
| 218 | <td class="mdRow"> |
---|
| 219 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 220 | <tr> |
---|
| 221 | <td class="md" nowrap valign="top">const uint32& FCDImage::GetHeight </td> |
---|
| 222 | <td class="md" valign="top">( </td> |
---|
| 223 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 224 | <td class="md" valign="top"> ) </td> |
---|
| 225 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 226 | </tr> |
---|
| 227 | </table> |
---|
| 228 | </td> |
---|
| 229 | </tr> |
---|
| 230 | </table> |
---|
| 231 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 232 | <tr> |
---|
| 233 | <td> |
---|
| 234 | |
---|
| 235 | </td> |
---|
| 236 | <td> |
---|
| 237 | |
---|
| 238 | <p> |
---|
| 239 | Retrieves the height of the image. |
---|
| 240 | <p> |
---|
| 241 | This parameter is useful for off-screen render targets and is optional for texture image files. <dl compact><dt><b>Returns:</b></dt><dd>The height of the image. This value will be zero to indicate that you should retrieve the height of the image from the image file. </dd></dl> |
---|
| 242 | </td> |
---|
| 243 | </tr> |
---|
| 244 | </table> |
---|
| 245 | <a class="anchor" name="137caaacfc6ee0f82a4f654e142f23ea"></a><!-- doxytag: member="FCDImage::GetType" ref="137caaacfc6ee0f82a4f654e142f23ea" args="() const " --><p> |
---|
| 246 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 247 | <tr> |
---|
| 248 | <td class="mdRow"> |
---|
| 249 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 250 | <tr> |
---|
| 251 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a> FCDImage::GetType </td> |
---|
| 252 | <td class="md" valign="top">( </td> |
---|
| 253 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 254 | <td class="md" valign="top"> ) </td> |
---|
| 255 | <td class="md" nowrap> const<code> [inline, virtual]</code></td> |
---|
| 256 | </tr> |
---|
| 257 | </table> |
---|
| 258 | </td> |
---|
| 259 | </tr> |
---|
| 260 | </table> |
---|
| 261 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 262 | <tr> |
---|
| 263 | <td> |
---|
| 264 | |
---|
| 265 | </td> |
---|
| 266 | <td> |
---|
| 267 | |
---|
| 268 | <p> |
---|
| 269 | Retrieves the entity type for this class. |
---|
| 270 | <p> |
---|
| 271 | This function is part of the <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> class interface. <dl compact><dt><b>Returns:</b></dt><dd>The entity type: IMAGE. </dd></dl> |
---|
| 272 | |
---|
| 273 | <p> |
---|
| 274 | Reimplemented from <a class="el" href="class_f_c_d_entity.html#bfd4312a7124f92364c1e6517c7e60ba">FCDEntity</a>. </td> |
---|
| 275 | </tr> |
---|
| 276 | </table> |
---|
| 277 | <a class="anchor" name="9ff868bc5bcf26c3c861844522dd93d9"></a><!-- doxytag: member="FCDImage::GetWidth" ref="9ff868bc5bcf26c3c861844522dd93d9" args="() const " --><p> |
---|
| 278 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 279 | <tr> |
---|
| 280 | <td class="mdRow"> |
---|
| 281 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 282 | <tr> |
---|
| 283 | <td class="md" nowrap valign="top">const uint32& FCDImage::GetWidth </td> |
---|
| 284 | <td class="md" valign="top">( </td> |
---|
| 285 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 286 | <td class="md" valign="top"> ) </td> |
---|
| 287 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 288 | </tr> |
---|
| 289 | </table> |
---|
| 290 | </td> |
---|
| 291 | </tr> |
---|
| 292 | </table> |
---|
| 293 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 294 | <tr> |
---|
| 295 | <td> |
---|
| 296 | |
---|
| 297 | </td> |
---|
| 298 | <td> |
---|
| 299 | |
---|
| 300 | <p> |
---|
| 301 | Retrieves the width of the image. |
---|
| 302 | <p> |
---|
| 303 | This parameter is useful for off-screen render targets and is optional for texture image files. <dl compact><dt><b>Returns:</b></dt><dd>The width of the image. This value will be zero to indicate that you should retrieve the width of the image from the image file. </dd></dl> |
---|
| 304 | </td> |
---|
| 305 | </tr> |
---|
| 306 | </table> |
---|
| 307 | <a class="anchor" name="99c1724e2dd75e6d877951e95ffebdc4"></a><!-- doxytag: member="FCDImage::LoadFromXML" ref="99c1724e2dd75e6d877951e95ffebdc4" args="(xmlNode *imageNode)" --><p> |
---|
| 308 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 309 | <tr> |
---|
| 310 | <td class="mdRow"> |
---|
| 311 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 312 | <tr> |
---|
| 313 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDImage::LoadFromXML </td> |
---|
| 314 | <td class="md" valign="top">( </td> |
---|
| 315 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 316 | <td class="mdname1" valign="top" nowrap> <em>imageNode</em> </td> |
---|
| 317 | <td class="md" valign="top"> ) </td> |
---|
| 318 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 319 | </tr> |
---|
| 320 | </table> |
---|
| 321 | </td> |
---|
| 322 | </tr> |
---|
| 323 | </table> |
---|
| 324 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 325 | <tr> |
---|
| 326 | <td> |
---|
| 327 | |
---|
| 328 | </td> |
---|
| 329 | <td> |
---|
| 330 | |
---|
| 331 | <p> |
---|
| 332 | [INTERNAL] Reads in the <image> element from a given COLLADA XML tree node. |
---|
| 333 | <p> |
---|
| 334 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 335 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 336 | <tr><td valign="top"></td><td valign="top"><em>imageNode</em> </td><td>The COLLADA XML tree node. </td></tr> |
---|
| 337 | </table> |
---|
| 338 | </dl> |
---|
| 339 | <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 image. </dd></dl> |
---|
| 340 | |
---|
| 341 | <p> |
---|
| 342 | Reimplemented from <a class="el" href="class_f_c_d_entity.html#8e32fcc93de76acc4b606db7b5b83890">FCDEntity</a>. </td> |
---|
| 343 | </tr> |
---|
| 344 | </table> |
---|
| 345 | <a class="anchor" name="bb4f63a3f2e886ad6bacb9be0ebab2d5"></a><!-- doxytag: member="FCDImage::SetDepth" ref="bb4f63a3f2e886ad6bacb9be0ebab2d5" args="(uint32 _depth)" --><p> |
---|
| 346 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 347 | <tr> |
---|
| 348 | <td class="mdRow"> |
---|
| 349 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 350 | <tr> |
---|
| 351 | <td class="md" nowrap valign="top">void FCDImage::SetDepth </td> |
---|
| 352 | <td class="md" valign="top">( </td> |
---|
| 353 | <td class="md" nowrap valign="top">uint32 </td> |
---|
| 354 | <td class="mdname1" valign="top" nowrap> <em>_depth</em> </td> |
---|
| 355 | <td class="md" valign="top"> ) </td> |
---|
| 356 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 357 | </tr> |
---|
| 358 | </table> |
---|
| 359 | </td> |
---|
| 360 | </tr> |
---|
| 361 | </table> |
---|
| 362 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 363 | <tr> |
---|
| 364 | <td> |
---|
| 365 | |
---|
| 366 | </td> |
---|
| 367 | <td> |
---|
| 368 | |
---|
| 369 | <p> |
---|
| 370 | Sets the depth of the 3D image. |
---|
| 371 | <p> |
---|
| 372 | This parameter is optional for texture image files. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 373 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 374 | <tr><td valign="top"></td><td valign="top"><em>_depth</em> </td><td>The depth of the image. This value can be zero to indicate that you should retrieve the depth of the image from the image file. </td></tr> |
---|
| 375 | </table> |
---|
| 376 | </dl> |
---|
| 377 | </td> |
---|
| 378 | </tr> |
---|
| 379 | </table> |
---|
| 380 | <a class="anchor" name="9489bc2214865330b82029f949ceedf7"></a><!-- doxytag: member="FCDImage::SetFilename" ref="9489bc2214865330b82029f949ceedf7" args="(const fstring &_filename)" --><p> |
---|
| 381 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 382 | <tr> |
---|
| 383 | <td class="mdRow"> |
---|
| 384 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 385 | <tr> |
---|
| 386 | <td class="md" nowrap valign="top">void FCDImage::SetFilename </td> |
---|
| 387 | <td class="md" valign="top">( </td> |
---|
| 388 | <td class="md" nowrap valign="top">const fstring & </td> |
---|
| 389 | <td class="mdname1" valign="top" nowrap> <em>_filename</em> </td> |
---|
| 390 | <td class="md" valign="top"> ) </td> |
---|
| 391 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 392 | </tr> |
---|
| 393 | </table> |
---|
| 394 | </td> |
---|
| 395 | </tr> |
---|
| 396 | </table> |
---|
| 397 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 398 | <tr> |
---|
| 399 | <td> |
---|
| 400 | |
---|
| 401 | </td> |
---|
| 402 | <td> |
---|
| 403 | |
---|
| 404 | <p> |
---|
| 405 | Sets the filename of the image file. |
---|
| 406 | <p> |
---|
| 407 | This is the image file that you should load when attempting to use the image bits. <a class="el" href="namespace_f_collada.html">FCollada</a> will deal with the filename internally and export a relative filename. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 408 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 409 | <tr><td valign="top"></td><td valign="top"><em>_filename</em> </td><td>The filename of the image file. </td></tr> |
---|
| 410 | </table> |
---|
| 411 | </dl> |
---|
| 412 | </td> |
---|
| 413 | </tr> |
---|
| 414 | </table> |
---|
| 415 | <a class="anchor" name="ff423a44ea5f473505efc3e35773e980"></a><!-- doxytag: member="FCDImage::SetHeight" ref="ff423a44ea5f473505efc3e35773e980" args="(uint32 _height)" --><p> |
---|
| 416 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 417 | <tr> |
---|
| 418 | <td class="mdRow"> |
---|
| 419 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 420 | <tr> |
---|
| 421 | <td class="md" nowrap valign="top">void FCDImage::SetHeight </td> |
---|
| 422 | <td class="md" valign="top">( </td> |
---|
| 423 | <td class="md" nowrap valign="top">uint32 </td> |
---|
| 424 | <td class="mdname1" valign="top" nowrap> <em>_height</em> </td> |
---|
| 425 | <td class="md" valign="top"> ) </td> |
---|
| 426 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 427 | </tr> |
---|
| 428 | </table> |
---|
| 429 | </td> |
---|
| 430 | </tr> |
---|
| 431 | </table> |
---|
| 432 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 433 | <tr> |
---|
| 434 | <td> |
---|
| 435 | |
---|
| 436 | </td> |
---|
| 437 | <td> |
---|
| 438 | |
---|
| 439 | <p> |
---|
| 440 | Sets the height of the image. |
---|
| 441 | <p> |
---|
| 442 | This parameter is useful for off-screen render targets and is optional for texture image files. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 443 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 444 | <tr><td valign="top"></td><td valign="top"><em>_height</em> </td><td>The height of the image. This value can be zero to indicate that you should retrieve the width of the image from the image file. </td></tr> |
---|
| 445 | </table> |
---|
| 446 | </dl> |
---|
| 447 | </td> |
---|
| 448 | </tr> |
---|
| 449 | </table> |
---|
| 450 | <a class="anchor" name="1b095ed4b987f695fc4b742d4c4cfb5e"></a><!-- doxytag: member="FCDImage::SetWidth" ref="1b095ed4b987f695fc4b742d4c4cfb5e" args="(uint32 _width)" --><p> |
---|
| 451 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 452 | <tr> |
---|
| 453 | <td class="mdRow"> |
---|
| 454 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 455 | <tr> |
---|
| 456 | <td class="md" nowrap valign="top">void FCDImage::SetWidth </td> |
---|
| 457 | <td class="md" valign="top">( </td> |
---|
| 458 | <td class="md" nowrap valign="top">uint32 </td> |
---|
| 459 | <td class="mdname1" valign="top" nowrap> <em>_width</em> </td> |
---|
| 460 | <td class="md" valign="top"> ) </td> |
---|
| 461 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 462 | </tr> |
---|
| 463 | </table> |
---|
| 464 | </td> |
---|
| 465 | </tr> |
---|
| 466 | </table> |
---|
| 467 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 468 | <tr> |
---|
| 469 | <td> |
---|
| 470 | |
---|
| 471 | </td> |
---|
| 472 | <td> |
---|
| 473 | |
---|
| 474 | <p> |
---|
| 475 | Sets the width of the image. |
---|
| 476 | <p> |
---|
| 477 | This parameter is useful for off-screen render targets and is optional for texture image files. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 478 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 479 | <tr><td valign="top"></td><td valign="top"><em>_width</em> </td><td>The width of the image. This value can be zero to indicate that you should retrieve the width of the image from the image file. </td></tr> |
---|
| 480 | </table> |
---|
| 481 | </dl> |
---|
| 482 | </td> |
---|
| 483 | </tr> |
---|
| 484 | </table> |
---|
| 485 | <a class="anchor" name="d894beaf27b521c96e5bbe982ab7e2f2"></a><!-- doxytag: member="FCDImage::WriteToXML" ref="d894beaf27b521c96e5bbe982ab7e2f2" args="(xmlNode *parentNode) const " --><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">virtual xmlNode* FCDImage::WriteToXML </td> |
---|
| 492 | <td class="md" valign="top">( </td> |
---|
| 493 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 494 | <td class="mdname1" valign="top" nowrap> <em>parentNode</em> </td> |
---|
| 495 | <td class="md" valign="top"> ) </td> |
---|
| 496 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
| 497 | </tr> |
---|
| 498 | </table> |
---|
| 499 | </td> |
---|
| 500 | </tr> |
---|
| 501 | </table> |
---|
| 502 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 503 | <tr> |
---|
| 504 | <td> |
---|
| 505 | |
---|
| 506 | </td> |
---|
| 507 | <td> |
---|
| 508 | |
---|
| 509 | <p> |
---|
| 510 | [INTERNAL] Writes out the <image> element to the given COLLADA XML tree node. |
---|
| 511 | <p> |
---|
| 512 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 513 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 514 | <tr><td valign="top"></td><td valign="top"><em>parentNode</em> </td><td>The COLLADA XML parent node in which to insert the image. </td></tr> |
---|
| 515 | </table> |
---|
| 516 | </dl> |
---|
| 517 | <dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl> |
---|
| 518 | |
---|
| 519 | <p> |
---|
| 520 | Reimplemented from <a class="el" href="class_f_c_d_entity.html#b27f0c175c3f8fd7064cde48bcf1d7a0">FCDEntity</a>. </td> |
---|
| 521 | </tr> |
---|
| 522 | </table> |
---|
| 523 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 524 | <li>FCDocument/<a class="el" href="_f_c_d_image_8h-source.html">FCDImage.h</a></ul> |
---|
| 525 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by |
---|
| 526 | <a href="http://www.doxygen.org/index.html"> |
---|
| 527 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 528 | </body> |
---|
| 529 | </html> |
---|