PSF-LoginServer/net/psforever/objects/geometry/GeometryForm$.html

17 lines
46 KiB
HTML
Raw Normal View History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.geometry.GeometryForm</title><meta content="PSF - LoginServer - master - net.psforever.objects.geometry.GeometryForm" name="description"/><meta content="PSF LoginServer master net.psforever.objects.geometry.GeometryForm" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../../lib/index.js"></script><script type="text/javascript" src="../../../../index.js"></script><script type="text/javascript" src="../../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.geometry" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="geometry"></a><a id="geometry:geometry"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">geometry</span>
positioned following the axis of rotation (the entity's base).</p><div class="fullcomment"><div class="comment cmt"><p>The geometric representation is a sphere around the entity's centroid
positioned following the axis of rotation (the entity's base).</p></div><dl class="paramcmts block"><dt class="param">radius</dt><dd class="cmt"><p>how wide a hemisphere is</p></dd><dt class="param">o</dt><dd class="cmt"><p>the entity</p></dd><dt>returns</dt><dd class="cmt"><p>the representation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.geometry.GeometryForm#representBySphere" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="representBySphere(radius:Float)(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry"></a><a id="representBySphere(Float)(Any):VolumetricGeometry"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/GeometryForm$.html#representBySphere(radius:Float)(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">representBySphere</span><span class="params">(<span name="radius">radius: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="params">(<span name="o">o: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <a href="d3/VolumetricGeometry.html" name="net.psforever.objects.geometry.d3.VolumetricGeometry" id="net.psforever.objects.geometry.d3.VolumetricGeometry" class="extype">VolumetricGeometry</a></span></span><p class="shortcomment cmt">The geometric representation is a sphere using a position as the entity's centroid
and all points exist a distance from that point.</p><div class="fullcomment"><div class="comment cmt"><p>The geometric representation is a sphere using a position as the entity's centroid
and all points exist a distance from that point.</p></div><dl class="paramcmts block"><dt class="param">radius</dt><dd class="cmt"><p>how wide a quarter-sphere is</p></dd><dt class="param">o</dt><dd class="cmt"><p>the entity</p></dd><dt>returns</dt><dd class="cmt"><p>the representation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.geometry.GeometryForm#representBySphereOnBase" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="representBySphereOnBase(radius:Float)(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry"></a><a id="representBySphereOnBase(Float)(Any):VolumetricGeometry"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/GeometryForm$.html#representBySphereOnBase(radius:Float)(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">representBySphereOnBase</span><span class="params">(<span name="radius">radius: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="params">(<span name="o">o: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <a href="d3/VolumetricGeometry.html" name="net.psforever.objects.geometry.d3.VolumetricGeometry" id="net.psforever.objects.geometry.d3.VolumetricGeometry" class="extype">VolumetricGeometry</a></span></span><p class="shortcomment cmt">The geometric representation is a sphere using a position as the entity's base (foot position)
and the centroid is located just above it a fixed distance.</p><div class="fullcomment"><div class="comment cmt"><p>The geometric representation is a sphere using a position as the entity's base (foot position)
and the centroid is located just above it a fixed distance.
All points exist a distance from that centroid.</p></div><dl class="paramcmts block"><dt class="param">radius</dt><dd class="cmt"><p>how wide a quarter-sphere is</p></dd><dt class="param">o</dt><dd class="cmt"><p>the entity</p></dd><dt>returns</dt><dd class="cmt"><p>the representation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.geometry.GeometryForm#representHoveringEntityByCylinder" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="representHoveringEntityByCylinder(radius:Float,height:Float,hoversAt:Float)(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry"></a><a id="representHoveringEntityByCylinder(Float,Float,Float)(Any):VolumetricGeometry"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/GeometryForm$.html#representHoveringEntityByCylinder(radius:Float,height:Float,hoversAt:Float)(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">representHoveringEntityByCylinder</span><span class="params">(<span name="radius">radius: <span name="scala.Float" class="extype">Float</span></span>, <span name="height">height: <span name="scala.Float" class="extype">Float</span></span>, <span name="hoversAt">hoversAt: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="params">(<span name="o">o: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <a href="d3/VolumetricGeometry.html" name="net.psforever.objects.geometry.d3.VolumetricGeometry" id="net.psforever.objects.geometry.d3.VolumetricGeometry" class="extype">VolumetricGeometry</a></span></span><p class="shortcomment cmt">The geometric representation is a cylinder around the entity's base
as if the target is displaced from the ground at an expected (fixed?) distance.</p><div class="fullcomment"><div class="comment cmt"><p>The geometric representation is a cylinder around the entity's base
as if the target is displaced from the ground at an expected (fixed?) distance.</p></div><dl class="paramcmts block"><dt class="param">radius</dt><dd class="cmt"><p>half the distance across</p></dd><dt class="param">height</dt><dd class="cmt"><p>how tall the cylinder is (the distance of the top to the base)</p></dd><dt class="param">hoversAt</dt><dd class="cmt"><p>how far off the base coordinates the actual cylinder begins</p></dd><dt class="param">o</dt><dd class="cmt"><p>the entity</p></dd><dt>returns</dt><dd class="cmt"><p>the representation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.geometry.GeometryForm#representPlayerByCylinder" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="representPlayerByCylinder(radius:Float)(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry"></a><a id="representPlayerByCylinder(Float)(Any):VolumetricGeometry"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/GeometryForm$.html#representPlayerByCylinder(radius:Float)(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">representPlayerByCylinder</span><span class="params">(<span name="radius">radius: <span name="scala.Float" class="extype">Float</span></span>)</span><span class="params">(<span name="o">o: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <a href="d3/VolumetricGeometry.html" name="net.psforever.objects.geometry.d3.VolumetricGeometry" id="net.psforever.objects.geometry.d3.VolumetricGeometry" class="extype">VolumetricGeometry</a></span></span><p class="shortcomment cmt">The geometric representation is a cylinder around the entity's base
if the target represents a player entity.</p><div class="fullcomment"><div class="comment cmt"><p>The geometric representation is a cylinder around the entity's base
if the target represents a player entity.</p></div><dl class="paramcmts block"><dt class="param">radius</dt><dd class="cmt"><p>a measure of the player's bulk</p></dd><dt class="param">o</dt><dd class="cmt"><p>the entity</p></dd><dt>returns</dt><dd class="cmt"><p>the representation</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.geometry.GeometryForm#representProjectileBySphere" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="representProjectileBySphere()(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry"></a><a id="representProjectileBySphere()(Any):VolumetricGeometry"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/GeometryForm$.html#representProjectileBySphere()(o:Any):net.psforever.objects.geometry.d3.VolumetricGeometry" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">representProjectileBySphere</span><span class="params">()</span><span class="params">(<span name="o">o: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <a href="d3/VolumetricGeometry.html" name="net.psforever.objects.geometry.d3.VolumetricGeometry" id="net.psforever.objects.geometry.d3.VolumetricGeometry" class="extype">VolumetricGeometry</a></span></span><p class="shortcomment cmt">The geometric representation is a sphere around the entity's centroid
positioned following the axis of rotation (the entity's base).</p><div class="fullcomment"><div class="comment cmt"><p>The geometric representation is a sphere around the entity's centroid
positioned following the axis of rotation (the entity's base).
The specific entity should be a projectile, else the result is invalid.</p></div><dl class="paramcmts block"><dt class="param">o</dt><dd class="cmt"><p>the entity</p></dd><dt>returns</dt><dd class="cmt"><p>the representation</p></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=&gt;T0):T0"></a><a id="synchronized[T0](=&gt;T0):T0"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/GeometryForm$.html#synchronized[T0](x$1:=&gt;T0):T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: =&gt; <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/GeometryForm$.html#toString():String" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">toString</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#java.lang.String" name="java.lang.String" id="java.lang.String" class="extype">String</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/GeometryForm$.html#wait():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/geometry/GeometryForm$.html#wait(x$1:Long,x$2:Int):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-i