34 lines
14 KiB
HTML
34 lines
14 KiB
HTML
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>SpriteInfo Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="SpriteInfo class" /><meta name="System.Keywords" content="SpriteLibrary.SpriteInfo class" /><meta name="System.Keywords" content="SpriteInfo class, about SpriteInfo class" /><meta name="Microsoft.Help.F1" content="SpriteLibrary.SpriteInfo" /><meta name="Microsoft.Help.Id" content="T:SpriteLibrary.SpriteInfo" /><meta name="Description" content="A class which is used by the SpriteDatabase to build Sprites. You should not need to use this in your programming. It is simplest to use the Load/Save features of the SpriteDatabase, which will load and save the SpriteInfo." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="SpriteLibrary" /><meta name="file" content="ea3329cc-ea39-b02b-025e-fc9ac7e40cd8" /><meta name="guid" content="ea3329cc-ea39-b02b-025e-fc9ac7e40cd8" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">SpriteLibrary<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm" title="SpriteLibrary" tocid="roottoc">SpriteLibrary</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm" title="SpriteLibrary" tocid="6b7227c0-7a6a-6342-3b08-917c7de429cc">SpriteLibrary</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="ea3329cc-ea39-b02b-025e-fc9ac7e40cd8.htm" title="SpriteInfo Class" tocid="ea3329cc-ea39-b02b-025e-fc9ac7e40cd8">SpriteInfo Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="5fe094d1-25cb-4659-c77c-ccf1c0450b7c.htm" title="SpriteInfo Constructor " tocid="5fe094d1-25cb-4659-c77c-ccf1c0450b7c">SpriteInfo Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="6fd31706-c5be-87f8-1b62-04ed7f7d9e90.htm" title="SpriteInfo Methods" tocid="6fd31706-c5be-87f8-1b62-04ed7f7d9e90">SpriteInfo Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="fb676f66-0439-9787-e91c-371c56d66cce.htm" title="SpriteInfo Fields" tocid="fb676f66-0439-9787-e91c-371c56d66cce">SpriteInfo Fields</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn"><h1>SpriteInfo Class</h1></td></tr></table><span class="introStyle"></span> <div class="summary">
|
||
A class which is used by the <a href="b2b20aab-3fc0-1b0f-8fda-213dbc180690.htm">SpriteDatabase</a> to build
|
||
Sprites. You should not need to use this in your programming. It is simplest to use the Load/Save features
|
||
of the SpriteDatabase, which will load and save the SpriteInfo.
|
||
Again, you do not want to use these within
|
||
your program. Let the SpriteDatabase use this. The reason these are visible to the program is because
|
||
This code uses "XML Serialization" to load and save. XML Serialization requires the items you are
|
||
serializing to be "public", which makes them visible.
|
||
</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LST4B507365_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4B507365_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br /> <span class="selflink">SpriteLibrary<span id="LST4B507365_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4B507365_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>SpriteInfo</span><br /></div><p> </p>
|
||
<strong>Namespace:</strong>
|
||
<a href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm">SpriteLibrary</a><br />
|
||
<strong>Assembly:</strong>
|
||
SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID1EACA');return false;" title="Copy">Copy</a></div></div><div id="ID1EACA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">SpriteInfo</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EACA");</script></div><p>The <span class="selflink">SpriteInfo</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table class="members" id="constructorList"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="5fe094d1-25cb-4659-c77c-ccf1c0450b7c.htm">SpriteInfo</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">SpriteInfo</span> class</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID4RBSection" class="collapsibleSection"><table class="members" id="methodList"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="949b6b09-68f2-5775-7d24-28efd893a244.htm">Clone</a></td><td><div class="summary">
|
||
A generic cloning method that works when everything is public
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="a6b3d508-3301-8e4a-0f2e-bed5f22f3e90.htm">CopyFrom</a></td><td><div class="summary">
|
||
Update the current SpriteInfo class such that it is identical to the class you are copying from.
|
||
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">ToString</a></td><td> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID5RBSection" class="collapsibleSection"><table class="members" id="fieldList"><tr><th class="iconColumn">
|
||
|
||
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="a737620e-6604-1a1b-df59-3458c3402c9d.htm">Animations</a></td><td><div class="summary">
|
||
This is the list of animations that make up the sprite. Again, you do not want to use these within
|
||
your program. Let the SpriteDatabase use this. The reason these are visible to the program is because
|
||
This code uses "XML Serialization" to load and save. XML Serialization requires the items you are
|
||
serializing to be "public", which makes them visible.
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="12e2fe0e-0922-3f46-f249-22e1afc051c0.htm">SpriteName</a></td><td><div class="summary">
|
||
The name of the sprite. It should be unique within your application
|
||
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="fb5d39a1-88e9-1efd-064c-d209a98e8644.htm">ViewPercent</a></td><td><div class="summary">
|
||
The percentage size when the sprite is normally displayed. For example: If the image you drew your
|
||
sprite on has your sprite drawn on a 200x200 grid, but you want your sprite to normally be 100x100,
|
||
you would tell it to be 50 (50 percent of the original size).
|
||
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID6RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm">SpriteLibrary Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html> |