<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>OpenSceneGraph: osg::PointSprite Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"> <ul> <li><a class="el" href="a01628.html">osg</a> </li> <li><a class="el" href="a00564.html">osg::PointSprite</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <h1>osg::PointSprite Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="osg::PointSprite" --><!-- doxytag: inherits="osg::StateAttribute" --> <p><a class="el" href="a00564.html" title="PointSprite base class which encapsulates enabling of point sprites .">PointSprite</a> base class which encapsulates enabling of point sprites . <a href="#_details">More...</a></p> <div class="dynheader"> Inheritance diagram for osg::PointSprite:</div> <div class="dyncontent"> <div class="center"><img src="a02178.png" border="0" usemap="#osg_1_1PointSprite_inherit__map" alt="Inheritance graph"/></div> <map name="osg_1_1PointSprite_inherit__map" id="osg_1_1PointSprite_inherit__map"> <area shape="rect" id="node2" href="a00743.html" title="Base class for state attributes." alt="" coords="5,160,136,189"/><area shape="rect" id="node4" href="a00500.html" title="Base class/standard interface for objects which require IO support, cloning and reference counting..." alt="" coords="27,83,115,112"/><area shape="rect" id="node6" href="a00627.html" title="Base class from providing referencing counted objects." alt="" coords="12,5,129,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="a02179.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-types"></a> Public Types</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5e">CoordOriginMode</a> { <a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5eaede8fc2a529ccce209e61f26e3d4d848">UPPER_LEFT</a> = GL_UPPER_LEFT, <a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5eaeaedfd56f77d87ab44195e613bcfddcc">LOWER_LEFT</a> = GL_LOWER_LEFT }</td></tr> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#ac3b73bd75ceddcba4ce87d8caf5b12f0">PointSprite</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#a8557f8285d9f30418a6ee82f8d8e5246">PointSprite</a> (const <a class="el" href="a00564.html">PointSprite</a> &ps, const <a class="el" href="a00169.html">osg::CopyOp</a> &copyop=osg::CopyOp::SHALLOW_COPY)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor using <a class="el" href="a00169.html" title="Copy Op(erator) used to control whether shallow or deep copy is used during copy construction and clo...">CopyOp</a> to manage deep vs shallow copy. <a href="#a8557f8285d9f30418a6ee82f8d8e5246"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#accfc6087890ad1397173e1422bf05402">META_StateAttribute</a> (osg, <a class="el" href="a00564.html">PointSprite</a>, POINTSPRITE)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#af23a5d58b664cdd9187f33f976df045d">compare</a> (const <a class="el" href="a00743.html">StateAttribute</a> &sa) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. <a href="#af23a5d58b664cdd9187f33f976df045d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#ac126a1741621e7ce511158ede2d7ad4c">getModeUsage</a> (<a class="el" href="a00475.html">StateAttribute::ModeUsage</a> &usage) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the modes associated with this <a class="el" href="a00743.html" title="Base class for state attributes.">StateAttribute</a>. <a href="#ac126a1741621e7ce511158ede2d7ad4c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#ad3a21265951cada3fcb4c9292f962080">checkValidityOfAssociatedModes</a> (<a class="el" href="a00742.html">osg::State</a> &) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check the modes associated with this <a class="el" href="a00743.html" title="Base class for state attributes.">StateAttribute</a> are supported by current OpenGL drivers, and if not set the associated mode in <a class="el" href="a00742.html" title="Encapsulates the current applied OpenGL modes, attributes and vertex arrays settings, implements lazy state updating and provides accessors for querying the current state.">osg::State</a> to be black listed/invalid. <a href="#ad3a21265951cada3fcb4c9292f962080"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#a8a5298406b365e2cdaa382a1e3b8196b">isTextureAttribute</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if <a class="el" href="a00743.html" title="Base class for state attributes.">StateAttribute</a> is a type which controls texturing and needs to be issued w.r.t to specific texture unit. <a href="#a8a5298406b365e2cdaa382a1e3b8196b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#ade9b92b6757c234d9cfce8f8a442ae8a">apply</a> (<a class="el" href="a00742.html">osg::State</a> &state) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">apply the OpenGL state attributes. <a href="#ade9b92b6757c234d9cfce8f8a442ae8a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#abee4df61acc01c0af0dad512060227be">setCoordOriginMode</a> (<a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5e">CoordOriginMode</a> mode)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5e">CoordOriginMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#aa142986d9e6a9935f6f127de59b4978d">getCoordOriginMode</a> () const </td></tr> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#a343e5ea5d1e60d1288f04b4567349b08">isPointSpriteSupported</a> (unsigned int context)</td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#acb221f223ec199ec90df12a3ebf8d6da">~PointSprite</a> ()</td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5e">CoordOriginMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00564.html#af82c952b4748d3cf0ea3c5bf396c8dff">_coordOriginMode</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p><a class="el" href="a00564.html" title="PointSprite base class which encapsulates enabling of point sprites .">PointSprite</a> base class which encapsulates enabling of point sprites . </p> <hr/><h2>Member Enumeration Documentation</h2> <a class="anchor" id="a154408b268b994a90317b22a416a9a5e"></a><!-- doxytag: member="osg::PointSprite::CoordOriginMode" ref="a154408b268b994a90317b22a416a9a5e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5e">osg::PointSprite::CoordOriginMode</a></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" id="a154408b268b994a90317b22a416a9a5eaede8fc2a529ccce209e61f26e3d4d848"></a><!-- doxytag: member="UPPER_LEFT" ref="a154408b268b994a90317b22a416a9a5eaede8fc2a529ccce209e61f26e3d4d848" args="" -->UPPER_LEFT</em> </td><td> </td></tr> <tr><td valign="top"><em><a class="anchor" id="a154408b268b994a90317b22a416a9a5eaeaedfd56f77d87ab44195e613bcfddcc"></a><!-- doxytag: member="LOWER_LEFT" ref="a154408b268b994a90317b22a416a9a5eaeaedfd56f77d87ab44195e613bcfddcc" args="" -->LOWER_LEFT</em> </td><td> </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ac3b73bd75ceddcba4ce87d8caf5b12f0"></a><!-- doxytag: member="osg::PointSprite::PointSprite" ref="ac3b73bd75ceddcba4ce87d8caf5b12f0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">osg::PointSprite::PointSprite </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8557f8285d9f30418a6ee82f8d8e5246"></a><!-- doxytag: member="osg::PointSprite::PointSprite" ref="a8557f8285d9f30418a6ee82f8d8e5246" args="(const PointSprite &ps, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">osg::PointSprite::PointSprite </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00564.html">PointSprite</a> & </td> <td class="paramname"> <em>ps</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00169.html">osg::CopyOp</a> & </td> <td class="paramname"> <em>copyop</em> = <code>osg::CopyOp::SHALLOW_COPY</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Copy constructor using <a class="el" href="a00169.html" title="Copy Op(erator) used to control whether shallow or deep copy is used during copy construction and clo...">CopyOp</a> to manage deep vs shallow copy. </p> </div> </div> <a class="anchor" id="acb221f223ec199ec90df12a3ebf8d6da"></a><!-- doxytag: member="osg::PointSprite::~PointSprite" ref="acb221f223ec199ec90df12a3ebf8d6da" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual osg::PointSprite::~PointSprite </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ade9b92b6757c234d9cfce8f8a442ae8a"></a><!-- doxytag: member="osg::PointSprite::apply" ref="ade9b92b6757c234d9cfce8f8a442ae8a" args="(osg::State &state) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void osg::PointSprite::apply </td> <td>(</td> <td class="paramtype"><a class="el" href="a00742.html">osg::State</a> & </td> <td class="paramname"></td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>apply the OpenGL state attributes. </p> <p>The render info for the current OpenGL context is passed in to allow the <a class="el" href="a00743.html" title="Base class for state attributes.">StateAttribute</a> to obtain details on the the current context and state. </p> <p>Reimplemented from <a class="el" href="a00743.html#a579c9e2646b207f66acb7dc8653e9d75">osg::StateAttribute</a>.</p> </div> </div> <a class="anchor" id="ad3a21265951cada3fcb4c9292f962080"></a><!-- doxytag: member="osg::PointSprite::checkValidityOfAssociatedModes" ref="ad3a21265951cada3fcb4c9292f962080" args="(osg::State &) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool osg::PointSprite::checkValidityOfAssociatedModes </td> <td>(</td> <td class="paramtype"><a class="el" href="a00742.html">osg::State</a> & </td> <td class="paramname"></td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Check the modes associated with this <a class="el" href="a00743.html" title="Base class for state attributes.">StateAttribute</a> are supported by current OpenGL drivers, and if not set the associated mode in <a class="el" href="a00742.html" title="Encapsulates the current applied OpenGL modes, attributes and vertex arrays settings, implements lazy state updating and provides accessors for querying the current state.">osg::State</a> to be black listed/invalid. </p> <p>Return true if all associated modes are valid. </p> <p>Reimplemented from <a class="el" href="a00743.html#abbbbd8689af3c2b97e047cd6f83f5d17">osg::StateAttribute</a>.</p> </div> </div> <a class="anchor" id="af23a5d58b664cdd9187f33f976df045d"></a><!-- doxytag: member="osg::PointSprite::compare" ref="af23a5d58b664cdd9187f33f976df045d" args="(const StateAttribute &sa) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int osg::PointSprite::compare </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00743.html">StateAttribute</a> & </td> <td class="paramname"> <em>sa</em></td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. </p> <p>Implements <a class="el" href="a00743.html#a0ff33c0a11fc2e9980805b4d0325e16f">osg::StateAttribute</a>.</p> </div> </div> <a class="anchor" id="aa142986d9e6a9935f6f127de59b4978d"></a><!-- doxytag: member="osg::PointSprite::getCoordOriginMode" ref="aa142986d9e6a9935f6f127de59b4978d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5e">CoordOriginMode</a> osg::PointSprite::getCoordOriginMode </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ac126a1741621e7ce511158ede2d7ad4c"></a><!-- doxytag: member="osg::PointSprite::getModeUsage" ref="ac126a1741621e7ce511158ede2d7ad4c" args="(StateAttribute::ModeUsage &usage) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool osg::PointSprite::getModeUsage </td> <td>(</td> <td class="paramtype"><a class="el" href="a00475.html">StateAttribute::ModeUsage</a> & </td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return the modes associated with this <a class="el" href="a00743.html" title="Base class for state attributes.">StateAttribute</a>. </p> <p>Reimplemented from <a class="el" href="a00743.html#a1d6ef6841d265e7ac4164e9128bd0338">osg::StateAttribute</a>.</p> <p>References <a class="el" href="a01225.html#a08d2c10e808cb35e1eb1f067321a0a00">GL_POINT_SPRITE_ARB</a>, and <a class="el" href="a00475.html#ac1ae7f8c6abbd07eb355592f5bd2b65a">osg::StateAttribute::ModeUsage::usesMode()</a>.</p> </div> </div> <a class="anchor" id="a343e5ea5d1e60d1288f04b4567349b08"></a><!-- doxytag: member="osg::PointSprite::isPointSpriteSupported" ref="a343e5ea5d1e60d1288f04b4567349b08" args="(unsigned int context)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool osg::PointSprite::isPointSpriteSupported </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>context</em></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8a5298406b365e2cdaa382a1e3b8196b"></a><!-- doxytag: member="osg::PointSprite::isTextureAttribute" ref="a8a5298406b365e2cdaa382a1e3b8196b" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool osg::PointSprite::isTextureAttribute </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return true if <a class="el" href="a00743.html" title="Base class for state attributes.">StateAttribute</a> is a type which controls texturing and needs to be issued w.r.t to specific texture unit. </p> <p>Reimplemented from <a class="el" href="a00743.html#a54bc9e83b645d6507fa91a5ffb1fa9fc">osg::StateAttribute</a>.</p> </div> </div> <a class="anchor" id="accfc6087890ad1397173e1422bf05402"></a><!-- doxytag: member="osg::PointSprite::META_StateAttribute" ref="accfc6087890ad1397173e1422bf05402" args="(osg, PointSprite, POINTSPRITE)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">osg::PointSprite::META_StateAttribute </td> <td>(</td> <td class="paramtype">osg </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00564.html">PointSprite</a> </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">POINTSPRITE </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="abee4df61acc01c0af0dad512060227be"></a><!-- doxytag: member="osg::PointSprite::setCoordOriginMode" ref="abee4df61acc01c0af0dad512060227be" args="(CoordOriginMode mode)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void osg::PointSprite::setCoordOriginMode </td> <td>(</td> <td class="paramtype"><a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5e">CoordOriginMode</a> </td> <td class="paramname"> <em>mode</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="af82c952b4748d3cf0ea3c5bf396c8dff"></a><!-- doxytag: member="osg::PointSprite::_coordOriginMode" ref="af82c952b4748d3cf0ea3c5bf396c8dff" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00564.html#a154408b268b994a90317b22a416a9a5e">CoordOriginMode</a> <a class="el" href="a00564.html#af82c952b4748d3cf0ea3c5bf396c8dff">osg::PointSprite::_coordOriginMode</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>osg/<a class="el" href="a01225.html">PointSprite</a></li> </ul> </div> <hr> <table border="0"><tr><td> <img src="osg32-32.png" alt="osg logo" /> </td><td> <address><small>Generated at Thu Aug 19 2010 16:22:43 for the <a href="http://www.openscenegraph.org/">OpenSceneGraph</a> by <a href="http://www.doxygen.org">doxygen</a> 1.7.1.</small></address> <!-- Dimitri van Heesch's e-mail address removed, lest he get messages on the OpenSceneGraph --> </td></tr></table> </body> </html>