📄 classvtscene.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>vtlib library: vtScene Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.4.5 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li id="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</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><h1>vtScene Class Reference<br><small>[<a class="el" href="group__sg.html">Scene Graph</a>]</small></h1><!-- doxytag: class="vtScene" --><!-- doxytag: inherits="vtSceneBase" -->Inheritance diagram for vtScene:<p><center><img src="classvtScene__inherit__graph.png" border="0" usemap="#vtScene__inherit__map" alt="Inheritance graph"></center><map name="vtScene__inherit__map"><area href="classvtSceneBase.html" shape="rect" coords="7,7,108,34" alt=""></map><center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classvtScene-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>A Scene is the all-encompassing container for all 3D objects that are to be managed and drawn by the scene graph / graphics pipeline functionality of vtlib.<p>A Scene currently encapsulates:<ul><li>A scene graph</li><li>A set of engines (<a class="el" href="classvtEngine.html">vtEngine</a>)</li><li>A window</li><li>A current camera (<a class="el" href="classvtCamera.html">vtCamera</a>) </li></ul><p><table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dce70e89056bbba5db346d79588af220"></a><!-- doxytag: member="vtScene::SetRoot" ref="dce70e89056bbba5db346d79588af220" args="(vtGroup *pRoot)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#dce70e89056bbba5db346d79588af220">SetRoot</a> (<a class="el" href="classvtGroup.html">vtGroup</a> *pRoot)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the root node, the top node of the scene graph. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e3870443e91aff5ff4f72bf378a3d72"></a><!-- doxytag: member="vtScene::SetGlobalWireframe" ref="7e3870443e91aff5ff4f72bf378a3d72" args="(bool bWire)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#7e3870443e91aff5ff4f72bf378a3d72">SetGlobalWireframe</a> (bool bWire)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set global wireframe, which will force all objects to be drawn wireframe. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ada3d487908aebc2c305296b75a1439e"></a><!-- doxytag: member="vtScene::GetGlobalWireframe" ref="ada3d487908aebc2c305296b75a1439e" args="()" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#ada3d487908aebc2c305296b75a1439e">GetGlobalWireframe</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the global wireframe state. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#2c3e6e1ada8e3cd238d2dda7c799020a">Init</a> (bool bStereo=false, int iStereoMode=0)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Call this method once before calling any other vtlib methods. <a href="#2c3e6e1ada8e3cd238d2dda7c799020a"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d62605874538a0d60027c3b229f8a2c0"></a><!-- doxytag: member="vtScene::Shutdown" ref="d62605874538a0d60027c3b229f8a2c0" args="()" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#d62605874538a0d60027c3b229f8a2c0">Shutdown</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Call this method after all other vtlib methods, to free memory. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db51b1f5e257adc233c2bb5363a0ac81"></a><!-- doxytag: member="vtScene::GetFrameRate" ref="db51b1f5e257adc233c2bb5363a0ac81" args="()" -->float </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#db51b1f5e257adc233c2bb5363a0ac81">GetFrameRate</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the instantaneous framerate in frames per seconds estimated. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9dda391e2c3dedde6558ffcc4071026"></a><!-- doxytag: member="vtScene::GetTime" ref="e9dda391e2c3dedde6558ffcc4071026" args="()" -->float </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#e9dda391e2c3dedde6558ffcc4071026">GetTime</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Time in seconds since the scene began. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf5540eb6d678c3b142538bd72ad8239"></a><!-- doxytag: member="vtScene::GetFrameTime" ref="bf5540eb6d678c3b142538bd72ad8239" args="()" -->float </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#bf5540eb6d678c3b142538bd72ad8239">GetFrameTime</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Time in seconds between the start of the previous frame and the current frame. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#7c8010b698b89c60ae52d1730748b479">CameraRay</a> (const <a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/classIPoint2.html">IPoint2</a> &win, <a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/classFPoint3.html">FPoint3</a> &pos, <a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/classFPoint3.html">FPoint3</a> &dir, <a class="el" href="classvtWindow.html">vtWindow</a> *pWindow=<a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/MathTypes_8h.html#6c3e226b4d4795d518ab341b0824ec29">NULL</a>)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtScene.html#63bdd656ed7aa17e5c7a0621fea8d258">ComputeViewMatrix</a> (<a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/classFMatrix4.html">FMatrix4</a> &mat)</td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="7c8010b698b89c60ae52d1730748b479"></a><!-- doxytag: member="vtScene::CameraRay" ref="7c8010b698b89c60ae52d1730748b479" args="(const IPoint2 &win, FPoint3 &pos, FPoint3 &dir, vtWindow *pWindow=NULL)" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">bool vtScene::CameraRay </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/classIPoint2.html">IPoint2</a> & </td> <td class="mdname" nowrap> <em>win</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/classFPoint3.html">FPoint3</a> & </td> <td class="mdname" nowrap> <em>pos</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/classFPoint3.html">FPoint3</a> & </td> <td class="mdname" nowrap> <em>dir</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="el" href="classvtWindow.html">vtWindow</a> * </td> <td class="mdname" nowrap> <em>pWindow</em> = <code><a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/MathTypes_8h.html#6c3e226b4d4795d518ab341b0824ec29">NULL</a></code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Convert window coordinates (in pixels) to a ray from the camera in world coordinates. Pixel coordinates are measured from the top left corner of the window: X right, Y down. </td> </tr></table><a class="anchor" name="63bdd656ed7aa17e5c7a0621fea8d258"></a><!-- doxytag: member="vtScene::ComputeViewMatrix" ref="63bdd656ed7aa17e5c7a0621fea8d258" args="(FMatrix4 &mat)" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void vtScene::ComputeViewMatrix </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="elRef" doxygen="vtdata.tag:../vtdata/" href="../vtdata/classFMatrix4.html">FMatrix4</a> & </td> <td class="mdname1" valign="top" nowrap> <em>mat</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Compute the full current view transform as a matrix, which includes the projection of the camera and the transform to window coordinates.<p>This transform is the one used to convert XYZ points in world coodinates into XY window coordinates.<p>By inverting this matrix, you can "un-project" window coordinates back into the world.<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mat</em> </td><td>This matrix will receive the current view transform. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="2c3e6e1ada8e3cd238d2dda7c799020a"></a><!-- doxytag: member="vtScene::Init" ref="2c3e6e1ada8e3cd238d2dda7c799020a" args="(bool bStereo=false, int iStereoMode=0)" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">bool vtScene::Init </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">bool </td> <td class="mdname" nowrap> <em>bStereo</em> = <code>false</code>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>iStereoMode</em> = <code>0</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Initialize the vtlib library, including the display and scene graph. You should call this function only once, before any other vtlib calls.<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>bStereo</em> </td><td>True for a stereo display output. </td></tr> <tr><td valign="top"></td><td valign="top"><em>iStereoMode</em> </td><td>Currently for vtosg, supported values are 0 for Anaglyphic (red-blue) and 1 for Quad-buffer (shutter glasses). </td></tr> </table></dl> </td> </tr></table><hr size="1"><address style="align: right;"><small>Generated on Mon Jan 14 14:41:01 2008 for vtlib library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -