LuaDocs/Box

From Data Realms Wiki

Revision as of 01:08, 24 June 2011 (view source) 94.23.249.157 (Talk) (→Functions) ← Older edit		Revision as of 03:22, 28 June 2011 (view source) LuaBot (Talk | contribs) (Box - Automatically generated by LuaBot) Newer edit →
Line 28:		Line 28:
-	Geez, that's unbelievalbe. Kudos and such.	+	==Functions==
		+	===GetRandomPoint===
		+	Gets a random point within this box.
		+
		+	'''Arguments:'''
		+
		+	* None.
		+
		+	'''Return value:'''
		+
		+	The random point within the box.
		+
		+
		+	===Unflip===
		+	Makes the corner of this box represent the upper left corner, and both width and height will end up positive.
		+
		+	'''Arguments:'''
		+
		+	* None.
		+
		+	'''Return value:'''
		+
		+	None.
		+
		+
		+	===WithinBox===
		+	Tells whether a point is within the Box or not.
		+
		+	'''Arguments:'''
		+
		+	* The Vector describing the point to test for insideness.
		+
		+	'''Return value:'''
		+
		+	Inside the box or not.
		+
		+
		+	===WithinBoxX===
		+	Tells whether an x coordinate is within the Box's x-range or not.
		+
		+	'''Arguments:'''
		+
		+	* The coordinate describing the x value to test for insideness.
		+
		+	'''Return value:'''
		+
		+	Inside the box or not in the x axis.
		+
		+
		+	===WithinBoxY===
		+	Tells whether an y coordinate is within the Box's y-range or not.
		+
		+	'''Arguments:'''
		+
		+	* The coordinate describing the y value to test for insideness.
		+
		+	'''Return value:'''
		+
		+	Inside the box or not in the y axis.
		+
		+
		+	===GetWithinBoxX===
		+	Returns an X value constrained inside the Box and returns it.
		+
		+	'''Arguments:'''
		+
		+	* The X value to constrain inside the Box.
		+
		+	'''Return value:'''
		+
		+	The constrained value.
		+
		+
		+	===GetWithinBoxY===
		+	Returns an X value constrained inside the Box and returns it.
		+
		+	'''Arguments:'''
		+
		+	* The X value to constrain inside the Box.
		+
		+	'''Return value:'''
		+
		+	The constrained value.
		+
		+
		+	===GetWithinBox===
		+	Returns a copy of a point constrained inside this box.
		+
		+	'''Arguments:'''
		+
		+	* The Vector describing the point to constrain inside the box.
		+
		+	'''Return value:'''
		+
		+	The resulting point isnide the box.
		+
		+
		+
		+	[[LuaDocs/Index|'''Go back to Class Index''']]

---

Revision as of 03:22, 28 June 2011

Contents 1 Has no parent class 2 Properties 2.1 ClassName 2.2 Corner 2.3 Width 2.4 Height 2.5 Center 2.6 Area 3 Functions 3.1 GetRandomPoint 3.2 Unflip 3.3 WithinBox 3.4 WithinBoxX 3.5 WithinBoxY 3.6 GetWithinBoxX 3.7 GetWithinBoxY 3.8 GetWithinBox

Has no parent class

Generic Class. A useful 2D axis-aligned rectangle class.

Go back to Class Index

Properties

ClassName

Read-only property. The class name of this Box.A string with the friendly-formatted type name of this Box.

Corner

The primary corner of this boxA Vector with the primary corner of this box.

Width

The width of this box. Note that this can be negative if the box hasn't been righted with Unflip().A float value that represents the width value of this Box.

Height

The height of this box. Note that this can be negative if the box hasn't been righted with Unflip().A float value that represents the height value of this Box.

Center

Read-only property. The center point of this Box' area, in absolute Scene coordinates.The center point.

Area

Read-only property. The width times the height.The width times the height.

Functions

GetRandomPoint

Gets a random point within this box.

Arguments:

• None.

Return value:

The random point within the box.

Unflip

Makes the corner of this box represent the upper left corner, and both width and height will end up positive.

Arguments:

• None.

Return value:

None.

WithinBox

Tells whether a point is within the Box or not.

Arguments:

• The Vector describing the point to test for insideness.

Return value:

Inside the box or not.

WithinBoxX

Tells whether an x coordinate is within the Box's x-range or not.

Arguments:

• The coordinate describing the x value to test for insideness.

Return value:

Inside the box or not in the x axis.

WithinBoxY

Tells whether an y coordinate is within the Box's y-range or not.

Arguments:

• The coordinate describing the y value to test for insideness.

Return value:

Inside the box or not in the y axis.

GetWithinBoxX

Returns an X value constrained inside the Box and returns it.

Arguments:

• The X value to constrain inside the Box.

Return value:

The constrained value.

GetWithinBoxY

Returns an X value constrained inside the Box and returns it.

Arguments:

• The X value to constrain inside the Box.

Return value:

The constrained value.

GetWithinBox

Returns a copy of a point constrained inside this box.

Arguments:

• The Vector describing the point to constrain inside the box.

Return value:

The resulting point isnide the box.

Go back to Class Index