<html>
<head>
<title>Ogre::Ray class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::Ray Class Reference</h1>Representation of a ray in space, ie a line with an origin and direction.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>></code>
<p>
Collaboration diagram for Ogre::Ray:<p><center><img src="classOgre_1_1Ray__coll__graph.png" border="0" usemap="#Ogre_1_1Ray__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1Ray__coll__map">
<area href="classOgre_1_1Vector3.html" shape="rect" coords="7,35,100,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1Ray-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya0">Ray</a> ()</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya1">Ray</a> (const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &origin, const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &direction)</td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya2">~Ray</a> ()</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya3">setOrigin</a> (const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &origin)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the origin of the ray.</em> <a href="#Ogre_1_1Raya3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya4">getOrigin</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the origin of the ray.</em> <a href="#Ogre_1_1Raya4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya5">setDirection</a> (const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &dir)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the direction of the ray.</em> <a href="#Ogre_1_1Raya5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya6">getDirection</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the direction of the ray.</em> <a href="#Ogre_1_1Raya6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya7">getPoint</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> t) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the position of a point t units along the ray.</em> <a href="#Ogre_1_1Raya7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya8">operator *</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> t) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the position of a point t units along the ray.</em> <a href="#Ogre_1_1Raya8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::pair< bool, <a class="el" href="namespaceOgre.html#a349">Real</a> > </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya9">intersects</a> (const <a class="el" href="classOgre_1_1Plane.html">Plane</a> &p) const</td></tr>
<tr><td> </td><td><font size=-1><em>Tests whether this ray intersects the given plane.</em> <a href="#Ogre_1_1Raya9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::pair< bool, <a class="el" href="namespaceOgre.html#a349">Real</a> > </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya10">intersects</a> (const <a class="el" href="classOgre_1_1Sphere.html">Sphere</a> &s) const</td></tr>
<tr><td> </td><td><font size=-1><em>Tests whether this ray intersects the given sphere.</em> <a href="#Ogre_1_1Raya10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>std::pair< bool, <a class="el" href="namespaceOgre.html#a349">Real</a> > </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya11">intersects</a> (const <a class="el" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a> &box) const</td></tr>
<tr><td> </td><td><font size=-1><em>Tests whether this ray intersects the given box.</em> <a href="#Ogre_1_1Raya11"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Rayn0">mOrigin</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Rayn1">mDirection</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Representation of a ray in space, ie a line with an origin and direction.
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00036">36</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1Raya0" doxytag="Ogre::Ray::Ray"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::Ray::Ray </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </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>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00042">42</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Raya1" doxytag="Ogre::Ray::Ray"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::Ray::Ray </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td>
<td class="mdname" nowrap> <em>origin</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td>
<td class="mdname" nowrap> <em>direction</em></td>
</tr>
<tr>
<td></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>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00043">43</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Raya2" doxytag="Ogre::Ray::~Ray"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual Ogre::Ray::~Ray </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00045">45</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1Raya6" doxytag="Ogre::Ray::getDirection"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a>& Ogre::Ray::getDirection </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the direction of the ray.
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00055">55</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>.
<p>
Referenced by <a class="el" href="OgreMath_8cpp-source.html#l00264">Ogre::Math::intersects</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Raya4" doxytag="Ogre::Ray::getOrigin"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a>& Ogre::Ray::getOrigin </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the origin of the ray.
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00050">50</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>.
<p>
Referenced by <a class="el" href="OgreMath_8cpp-source.html#l00264">Ogre::Math::intersects</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Raya7" doxytag="Ogre::Ray::getPoint"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> Ogre::Ray::getPoint </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname1" valign="top" nowrap> <em>t</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the position of a point t units along the ray.
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00058">58</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Raya11" doxytag="Ogre::Ray::intersects"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::pair<bool, <a class="el" href="namespaceOgre.html#a349">Real</a>> Ogre::Ray::intersects </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>box</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Tests whether this ray intersects the given box.
<p>
<dl compact><dt><b>
Returns: </b><dd>
A pair structure where the first element indicates whether an intersection occurs, and if true, the second element will indicate the distance along the ray at which it intersects. This can be converted to a point in space by calling <a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya7">getPoint</a>(). </dl>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00093">93</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Raya10" doxytag="Ogre::Ray::intersects"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::pair<bool, <a class="el" href="namespaceOgre.html#a349">Real</a>> Ogre::Ray::intersects </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Sphere.html">Sphere</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>s</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Tests whether this ray intersects the given sphere.
<p>
<dl compact><dt><b>
Returns: </b><dd>
A pair structure where the first element indicates whether an intersection occurs, and if true, the second element will indicate the distance along the ray at which it intersects. This can be converted to a point in space by calling <a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya7">getPoint</a>(). </dl>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00083">83</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Raya9" doxytag="Ogre::Ray::intersects"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::pair<bool, <a class="el" href="namespaceOgre.html#a349">Real</a>> Ogre::Ray::intersects </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Plane.html">Plane</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>p</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Tests whether this ray intersects the given plane.
<p>
<dl compact><dt><b>
Returns: </b><dd>
A pair structure where the first element indicates whether an intersection occurs, and if true, the second element will indicate the distance along the ray at which it intersects. This can be converted to a point in space by calling <a class="el" href="classOgre_1_1Ray.html#Ogre_1_1Raya7">getPoint</a>(). </dl>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00073">73</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>.
<p>
Referenced by <a class="el" href="OgreSceneManager_8cpp-source.html#l01996">Ogre::DefaultRaySceneQuery::execute</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Raya8" doxytag="Ogre::Ray::operator *"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> Ogre::Ray::operator * </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname1" valign="top" nowrap> <em>t</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the position of a point t units along the ray.
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00063">63</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Raya5" doxytag="Ogre::Ray::setDirection"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Ray::setDirection </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>dir</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>
Sets the direction of the ray.
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00053">53</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Raya3" doxytag="Ogre::Ray::setOrigin"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Ray::setOrigin </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>origin</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>
Sets the origin of the ray.
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00048">48</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1Rayn1" doxytag="Ogre::Ray::mDirection"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> Ogre::Ray::mDirection<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00040">40</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Rayn0" doxytag="Ogre::Ray::mOrigin"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> Ogre::Ray::mOrigin<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreRay_8h-source.html#l00039">39</a> of file <a class="el" href="OgreRay_8h-source.html">OgreRay.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreRay_8h-source.html">OgreRay.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:19:20 2004
</p>
</body>
</html>
distrib
>
Mandriva
>
10.0
>
i586
>
media
>
contrib
>
by-pkgid
>
06719cf03808e17ae6f0852ca1052dc2
>
files
>
2791
