source: NonGTP/FCollada/Documentation/_f_c_d_asset_8h-source.html @ 964

Revision 964, 14.4 KB checked in by igarcia, 18 years ago (diff)
Line 
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: FCDocument/FCDAsset.h Source File</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&nbsp;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><a href="classes.html"><span>Classes</span></a></li>
14    <li id="current"><a href="files.html"><span>Files</span></a></li>
15    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
20    <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
21  </ul></div>
22<h1>FCDocument/FCDAsset.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
23<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2005-2006 Feeling Software Inc.</span>
24<a name="l00003"></a>00003 <span class="comment">    MIT License: http://www.opensource.org/licenses/mit-license.php</span>
25<a name="l00004"></a>00004 <span class="comment">*/</span>
26<a name="l00005"></a>00005
27<a name="l00006"></a>00006 <span class="preprocessor">#ifndef _FCD_ASSET_H_</span>
28<a name="l00007"></a>00007 <span class="preprocessor"></span><span class="preprocessor">#define _FCD_ASSET_H_</span>
29<a name="l00008"></a>00008 <span class="preprocessor"></span>
30<a name="l00009"></a>00009 <span class="preprocessor">#include "<a class="code" href="_f_c_d_object_8h.html">FCDocument/FCDObject.h</a>"</span>
31<a name="l00010"></a>00010 <span class="preprocessor">#include "<a class="code" href="_f_u_date_time_8h.html">FUtils/FUDateTime.h</a>"</span>
32<a name="l00011"></a>00011
33<a name="l00012"></a>00012 <span class="keyword">class </span>FCDAssetContributor;
34<a name="l00013"></a>00013
35<a name="l00014"></a>00014 <span class="keyword">typedef</span> <a class="code" href="classvector.html">vector&lt;FCDAssetContributor*&gt;</a> <a class="code" href="classvector.html">FCDAssetContributorList</a>;
36<a name="l00015"></a>00015
37<a name="l00016"></a>00016 <span class="keyword">class </span>FCOLLADA_EXPORT FCDAsset : <span class="keyword">public</span> <a class="code" href="class_f_c_d_object.html">FCDObject</a>
38<a name="l00017"></a>00017 {
39<a name="l00018"></a>00018 <span class="keyword">private</span>:
40<a name="l00019"></a>00019     <a class="code" href="_f_u_object_type_8h.html#8124b8a8706cd10260f8cd5a7bd8e691">DeclareObjectType</a>;
41<a name="l00020"></a>00020
42<a name="l00021"></a>00021 <a class="code" href="classvector.html">FCDAssetContributorList</a> contributors;
43<a name="l00022"></a>00022 <a class="code" href="class_f_u_date_time.html">FUDateTime</a> creationDateTime;
44<a name="l00023"></a>00023 <a class="code" href="class_f_u_date_time.html">FUDateTime</a> modifiedDateTime;
45<a name="l00024"></a>00024     fstring keywords;
46<a name="l00025"></a>00025     fstring revision;
47<a name="l00026"></a>00026     fstring subject;
48<a name="l00027"></a>00027     fstring title;
49<a name="l00028"></a>00028 <a class="code" href="class_f_m_vector3.html">FMVector3</a> upAxis;
50<a name="l00029"></a>00029
51<a name="l00030"></a>00030     <span class="comment">// &lt;unit&gt;</span>
52<a name="l00031"></a>00031     fstring unitName;
53<a name="l00032"></a>00032 <span class="keywordtype">float</span> unitConversionFactor;
54<a name="l00033"></a>00033
55<a name="l00034"></a>00034 <span class="keyword">public</span>:
56<a name="l00035"></a>00035     FCDAsset(<a class="code" href="class_f_c_document.html">FCDocument</a>* document);
57<a name="l00036"></a>00036 <span class="keyword">virtual</span> ~FCDAsset();
58<a name="l00037"></a>00037
59<a name="l00038"></a>00038     <span class="comment">// Direct contributor list access</span>
60<a name="l00039"></a>00039 <span class="keyword">inline</span> <a class="code" href="classvector.html">FCDAssetContributorList</a>&amp; GetContributors() { <span class="keywordflow">return</span> contributors; }
61<a name="l00040"></a>00040 <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="classvector.html">FCDAssetContributorList</a>&amp; GetContributors()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> contributors; }
62<a name="l00041"></a>00041 <span class="keyword">inline</span> size_t GetContributorCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> contributors.size(); }
63<a name="l00042"></a>00042 <span class="keyword">inline</span> FCDAssetContributor* GetContributor(size_t index) { <span class="keywordflow">return</span> index &lt; contributors.size() ? contributors[index] : NULL; }
64<a name="l00043"></a>00043 <span class="keyword">inline</span> <span class="keyword">const</span> FCDAssetContributor* GetContributor(size_t index)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> index &lt; contributors.size() ? contributors[index] : NULL; }
65<a name="l00044"></a>00044     FCDAssetContributor* AddContributor();
66<a name="l00045"></a>00045
67<a name="l00046"></a>00046     <span class="comment">// Direct accessors</span>
68<a name="l00047"></a>00047 <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="class_f_u_date_time.html">FUDateTime</a>&amp; GetCreationDateTime()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> creationDateTime; }
69<a name="l00048"></a>00048 <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="class_f_u_date_time.html">FUDateTime</a>&amp; GetModifiedDateTime()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> modifiedDateTime; }
70<a name="l00049"></a>00049 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetKeywords()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> keywords; }
71<a name="l00050"></a>00050 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetRevision()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> revision; }
72<a name="l00051"></a>00051 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetSubject()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> subject; }
73<a name="l00052"></a>00052 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetTitle()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> title; }
74<a name="l00053"></a>00053 <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="class_f_m_vector3.html">FMVector3</a>&amp; GetUpAxis()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> upAxis; }
75<a name="l00054"></a>00054 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetUnitName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> unitName; }
76<a name="l00055"></a>00055 <span class="keyword">inline</span> <span class="keywordtype">float</span> GetUnitConversionFactor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> unitConversionFactor; }
77<a name="l00056"></a>00056
78<a name="l00057"></a>00057     <span class="comment">// Direct mutators</span>
79<a name="l00058"></a>00058 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetKeywords(<span class="keyword">const</span> fstring&amp; _keywords) { keywords = _keywords; }
80<a name="l00059"></a>00059 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetRevision(<span class="keyword">const</span> fstring&amp; _revision) { revision = _revision; }
81<a name="l00060"></a>00060 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetSubject(<span class="keyword">const</span> fstring&amp; _subject) { subject = _subject; }
82<a name="l00061"></a>00061 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetTitle(<span class="keyword">const</span> fstring&amp; _title) { title = _title; }
83<a name="l00062"></a>00062 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetUpAxis(<span class="keyword">const</span> <a class="code" href="class_f_m_vector3.html">FMVector3</a>&amp; _upAxis) { upAxis = _upAxis; }
84<a name="l00063"></a>00063 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetUnitName(<span class="keyword">const</span> fstring&amp; _unitName) { unitName = _unitName; }
85<a name="l00064"></a>00064 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetUnitConversionFactor(<span class="keywordtype">float</span> factor) { unitConversionFactor = factor; }
86<a name="l00065"></a>00065
87<a name="l00066"></a>00066     <span class="comment">// Read in the &lt;asset&gt; element from a COLLADA xml document</span>
88<a name="l00067"></a>00067 <a class="code" href="class_f_u_status.html">FUStatus</a> LoadFromXML(xmlNode* assetNode);
89<a name="l00068"></a>00068
90<a name="l00069"></a>00069     <span class="comment">// Write out the &lt;asset&gt; element to a COLLADA xml node tree</span>
91<a name="l00070"></a>00070     <span class="comment">// Calling this function will update the 'last modified' timestamp.</span>
92<a name="l00071"></a>00071     xmlNode* WriteToXML(xmlNode* parentNode) <span class="keyword">const</span>;
93<a name="l00072"></a>00072 };
94<a name="l00073"></a>00073
95<a name="l00074"></a>00074 <span class="comment">// Encapsulates the &lt;asset&gt;&lt;contributor&gt; element</span>
96<a name="l00075"></a>00075 <span class="keyword">class </span>FCOLLADA_EXPORT FCDAssetContributor : <span class="keyword">public</span> <a class="code" href="class_f_c_d_object.html">FCDObject</a>
97<a name="l00076"></a>00076 {
98<a name="l00077"></a>00077 <span class="keyword">private</span>:
99<a name="l00078"></a>00078     <a class="code" href="_f_u_object_type_8h.html#8124b8a8706cd10260f8cd5a7bd8e691">DeclareObjectType</a>;
100<a name="l00079"></a>00079
101<a name="l00080"></a>00080     fstring author;
102<a name="l00081"></a>00081     fstring authoringTool;
103<a name="l00082"></a>00082     fstring comments;
104<a name="l00083"></a>00083     fstring copyright;
105<a name="l00084"></a>00084     fstring sourceData;
106<a name="l00085"></a>00085
107<a name="l00086"></a>00086 <span class="keyword">public</span>:
108<a name="l00087"></a>00087     FCDAssetContributor(<a class="code" href="class_f_c_document.html">FCDocument</a>* document);
109<a name="l00088"></a>00088 <span class="keyword">virtual</span> ~FCDAssetContributor();
110<a name="l00089"></a>00089
111<a name="l00090"></a>00090     <span class="comment">// Direct accessors</span>
112<a name="l00091"></a>00091 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetAuthor()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> author; }
113<a name="l00092"></a>00092 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetAuthoringTool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> authoringTool; }
114<a name="l00093"></a>00093 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetComments()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> comments; }
115<a name="l00094"></a>00094 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetCopyright()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> copyright; }
116<a name="l00095"></a>00095 <span class="keyword">inline</span> <span class="keyword">const</span> fstring&amp; GetSourceData()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> sourceData; }
117<a name="l00096"></a>00096
118<a name="l00097"></a>00097     <span class="comment">// Direct mutators</span>
119<a name="l00098"></a>00098 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetAuthor(<span class="keyword">const</span> fstring&amp; _author) { author = _author; }
120<a name="l00099"></a>00099 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetAuthoringTool(<span class="keyword">const</span> fstring&amp; _authoringTool) { authoringTool = _authoringTool; }
121<a name="l00100"></a>00100 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetComments(<span class="keyword">const</span> fstring&amp; _comments) { comments = _comments; }
122<a name="l00101"></a>00101 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetCopyright(<span class="keyword">const</span> fstring&amp; _copyright) { copyright = _copyright; }
123<a name="l00102"></a>00102 <span class="keyword">inline</span> <span class="keywordtype">void</span> SetSourceData(<span class="keyword">const</span> fstring&amp; _sourceData) { sourceData = _sourceData; }
124<a name="l00103"></a>00103
125<a name="l00104"></a>00104     <span class="comment">// Returns whether this contributor element contain any valid data</span>
126<a name="l00105"></a>00105 <span class="keywordtype">bool</span> IsEmpty() <span class="keyword">const</span>;
127<a name="l00106"></a>00106
128<a name="l00107"></a>00107     <span class="comment">// Read in the &lt;asset&gt;&lt;contributor&gt; element from a COLLADA xml document</span>
129<a name="l00108"></a>00108 <a class="code" href="class_f_u_status.html">FUStatus</a> LoadFromXML(xmlNode* contributorNode, <span class="keywordtype">bool</span> isPreCollada1_4=<span class="keyword">false</span>);
130<a name="l00109"></a>00109
131<a name="l00110"></a>00110     <span class="comment">// Write out the &lt;asset&gt;&lt;contributor&gt; element to a COLLADA xml node tree</span>
132<a name="l00111"></a>00111     xmlNode* WriteToXML(xmlNode* parentNode) <span class="keyword">const</span>;
133<a name="l00112"></a>00112 };
134<a name="l00113"></a>00113
135<a name="l00114"></a>00114 <span class="preprocessor">#endif // _FCD_ASSET_H_</span>
136</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:38 2006 for FCollada by&nbsp;
137<a href="http://www.doxygen.org/index.html">
138<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
139</body>
140</html>
Note: See TracBrowser for help on using the repository browser.