EpicKnarvik97/Fiasko
1
0
Fork 0
mirror of https://github.com/inf112-v20/Fiasko.git synced 2025-11-04 11:43:44 +01:00
Code Issues Projects Releases Wiki Activity
Files
b3e09dfb738200cc366432d7975c9237977eeeca
Fiasko/docs/javadoc/inf112/fiasko/roborally/ui/DrawableObject.html
EpicKnarvik97 5cd2787a1e Oppdaterer Javadoc
2020-05-07 19:17:02 +02:00

517 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Thu May 07 19:14:45 CEST 2020 -->
<title>DrawableObject</title>
<meta name="date" content="2020-05-07">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DrawableObject";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../inf112/fiasko/roborally/ui/RoboRallyUI.html" title="interface in inf112.fiasko.roborally.ui"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?inf112/fiasko/roborally/ui/DrawableObject.html" target="_top">Frames</a></li>
<li><a href="DrawableObject.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">inf112.fiasko.roborally.ui</div>
<h2 title="Class DrawableObject" class="title">Class DrawableObject</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>inf112.fiasko.roborally.ui.DrawableObject</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">DrawableObject</span>
extends java.lang.Object</pre>
<div class="block">This class represents an object that can be drawn using libgdx</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#DrawableObject-com.badlogic.gdx.graphics.g2d.TextureRegion-int-int-">DrawableObject</a></span>(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;texture,
int&nbsp;xPos,
int&nbsp;yPos)</code>
<div class="block">Initializes a new drawable object</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#DrawableObject-com.badlogic.gdx.graphics.g2d.TextureRegion-int-int-int-int-int-">DrawableObject</a></span>(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;texture,
int&nbsp;xPos,
int&nbsp;yPos,
int&nbsp;width,
int&nbsp;height,
int&nbsp;rotation)</code>
<div class="block">Initializes a drawable object</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#DrawableObject-com.badlogic.gdx.graphics.g2d.TextureRegion-int-int-int-int-int-boolean-boolean-">DrawableObject</a></span>(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;texture,
int&nbsp;xPos,
int&nbsp;yPos,
int&nbsp;width,
int&nbsp;height,
int&nbsp;rotation,
boolean&nbsp;flipX,
boolean&nbsp;flipY)</code>
<div class="block">Initializes a drawable object</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#flipX--">flipX</a></span>()</code>
<div class="block">Whether to flip the texture on the x-axis when rendering</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#flipY--">flipY</a></span>()</code>
<div class="block">Whether to flip the texture on the y-axis when rendering</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#getHeight--">getHeight</a></span>()</code>
<div class="block">Gets the height of the object</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#getRotation--">getRotation</a></span>()</code>
<div class="block">Gets the number of degrees to rotate the texture counterclockwise when rendering</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>com.badlogic.gdx.graphics.g2d.TextureRegion</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#getTexture--">getTexture</a></span>()</code>
<div class="block">Gets the texture to use for drawing the object</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#getWidth--">getWidth</a></span>()</code>
<div class="block">Gets the width of the object</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#getXPosition--">getXPosition</a></span>()</code>
<div class="block">Gets the x position the object should be drawn on
The x position should be in terms of the actual pixel position on the rendered game, not the position according
to the game tile.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/DrawableObject.html#getYPosition--">getYPosition</a></span>()</code>
<div class="block">Gets the y position the object should be drawn on
The y position should be in terms of the actual pixel position on the rendered game, not the position according
to the game tile.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DrawableObject-com.badlogic.gdx.graphics.g2d.TextureRegion-int-int-int-int-int-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrawableObject</h4>
<pre>public&nbsp;DrawableObject(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;texture,
int&nbsp;xPos,
int&nbsp;yPos,
int&nbsp;width,
int&nbsp;height,
int&nbsp;rotation,
boolean&nbsp;flipX,
boolean&nbsp;flipY)</pre>
<div class="block">Initializes a drawable object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>texture</code> - The texture to use for drawing the element</dd>
<dd><code>xPos</code> - The pixel to start drawing on for the x axis</dd>
<dd><code>yPos</code> - The pixel to start drawing on for the y axis</dd>
<dd><code>width</code> - The width of the element</dd>
<dd><code>height</code> - The height of the element</dd>
<dd><code>rotation</code> - The amount of degrees to rotate the element counterclockwise</dd>
<dd><code>flipX</code> - Whether to flip/mirror the element over the x axis</dd>
<dd><code>flipY</code> - Whether to flip/mirror the element over the y axis</dd>
</dl>
</li>
</ul>
<a name="DrawableObject-com.badlogic.gdx.graphics.g2d.TextureRegion-int-int-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrawableObject</h4>
<pre>public&nbsp;DrawableObject(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;texture,
int&nbsp;xPos,
int&nbsp;yPos,
int&nbsp;width,
int&nbsp;height,
int&nbsp;rotation)</pre>
<div class="block">Initializes a drawable object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>texture</code> - The texture to use for drawing the element</dd>
<dd><code>xPos</code> - The pixel to start drawing on for the x axis</dd>
<dd><code>yPos</code> - The pixel to start drawing on for the y axis</dd>
<dd><code>width</code> - The width of the element</dd>
<dd><code>height</code> - The height of the element</dd>
<dd><code>rotation</code> - The amount of degrees to rotate the element counterclockwise</dd>
</dl>
</li>
</ul>
<a name="DrawableObject-com.badlogic.gdx.graphics.g2d.TextureRegion-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DrawableObject</h4>
<pre>public&nbsp;DrawableObject(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;texture,
int&nbsp;xPos,
int&nbsp;yPos)</pre>
<div class="block">Initializes a new drawable object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>texture</code> - The texture to use for drawing the element</dd>
<dd><code>xPos</code> - The pixel to start drawing on for the x axis</dd>
<dd><code>yPos</code> - The pixel to start drawing on for the y axis</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTexture--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTexture</h4>
<pre>public&nbsp;com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;getTexture()</pre>
<div class="block">Gets the texture to use for drawing the object</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The texture of the object</dd>
</dl>
</li>
</ul>
<a name="getXPosition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXPosition</h4>
<pre>public&nbsp;int&nbsp;getXPosition()</pre>
<div class="block">Gets the x position the object should be drawn on
<p>The x position should be in terms of the actual pixel position on the rendered game, not the position according
to the game tile. E.g. (128,64) not (2,1).</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An x position libgdx</dd>
</dl>
</li>
</ul>
<a name="getYPosition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getYPosition</h4>
<pre>public&nbsp;int&nbsp;getYPosition()</pre>
<div class="block">Gets the y position the object should be drawn on
<p>The y position should be in terms of the actual pixel position on the rendered game, not the position according
to the game tile. E.g. (128,64) not (2,1).</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An x position libgdx</dd>
</dl>
</li>
</ul>
<a name="getWidth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWidth</h4>
<pre>public&nbsp;int&nbsp;getWidth()</pre>
<div class="block">Gets the width of the object</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A positive integer</dd>
</dl>
</li>
</ul>
<a name="getHeight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeight</h4>
<pre>public&nbsp;int&nbsp;getHeight()</pre>
<div class="block">Gets the height of the object</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A positive integer</dd>
</dl>
</li>
</ul>
<a name="getRotation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRotation</h4>
<pre>public&nbsp;int&nbsp;getRotation()</pre>
<div class="block">Gets the number of degrees to rotate the texture counterclockwise when rendering</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An integer</dd>
</dl>
</li>
</ul>
<a name="flipX--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flipX</h4>
<pre>public&nbsp;boolean&nbsp;flipX()</pre>
<div class="block">Whether to flip the texture on the x-axis when rendering</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the texture is to be flipped. False otherwise</dd>
</dl>
</li>
</ul>
<a name="flipY--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>flipY</h4>
<pre>public&nbsp;boolean&nbsp;flipY()</pre>
<div class="block">Whether to flip the texture on the y-axis when rendering</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the texture is to be flipped. False otherwise</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../inf112/fiasko/roborally/ui/RoboRallyUI.html" title="interface in inf112.fiasko.roborally.ui"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?inf112/fiasko/roborally/ui/DrawableObject.html" target="_top">Frames</a></li>
<li><a href="DrawableObject.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink