Scrollable3D

interface Scrollable3D

A Scrollable3D object has a visible 3D space which might be smaller than its real size. A 3D scrollable maintains a visible "cube" over its content which is usually bigger in at least one dimension than the actual part.

Functions

equals
Link copied to clipboard
common
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open fun hashCode(): Int
scrollBackwardBy
Link copied to clipboard
common
abstract fun scrollBackwardBy(y: Int): Position3D
Scrolls this Scrollable3D with depth units backward (depth axis).
scrollDownBy
Link copied to clipboard
common
abstract fun scrollDownBy(z: Int): Position3D
Scrolls this Scrollable3D with height units down (height axis).
scrollForwardBy
Link copied to clipboard
common
abstract fun scrollForwardBy(y: Int): Position3D
Scrolls this Scrollable3D by depth units forward (depth axis).
scrollLeftBy
Link copied to clipboard
common
abstract fun scrollLeftBy(x: Int): Position3D
Scrolls this Scrollable3D with width units to the left (width axis).
scrollOneBackward
Link copied to clipboard
common
abstract fun scrollOneBackward(): Position3D
Scrolls this Scrollable3D with one unit backward (depth axis, towards the observer).
scrollOneDown
Link copied to clipboard
common
abstract fun scrollOneDown(): Position3D
Scrolls this Scrollable3D with one unit down (height axis).
scrollOneForward
Link copied to clipboard
common
abstract fun scrollOneForward(): Position3D
Scrolls this Scrollable3D with one unit forward (depth axis, away from the observer).
scrollOneLeft
Link copied to clipboard
common
abstract fun scrollOneLeft(): Position3D
Scrolls this Scrollable3D with one unit to the left (width axis).
scrollOneRight
Link copied to clipboard
common
abstract fun scrollOneRight(): Position3D
Scrolls this Scrollable3D with one unit to the right (width axis).
scrollOneUp
Link copied to clipboard
common
abstract fun scrollOneUp(): Position3D
Scrolls this Scrollable3D with one unit up (height axis).
scrollRightBy
Link copied to clipboard
common
abstract fun scrollRightBy(x: Int): Position3D
Scrolls this Scrollable3D by width units to the right (width axis).
scrollTo
Link copied to clipboard
common
abstract fun scrollTo(position3D: Position3D)
Scrolls this Scrollable3D to the provided position
scrollUpBy
Link copied to clipboard
common
abstract fun scrollUpBy(z: Int): Position3D
Scrolls this Scrollable3D by height units up (height axis).
toString
Link copied to clipboard
common
open fun toString(): String

Properties

actualSize
Link copied to clipboard
common
abstract val actualSize: Size3D
Returns the Size3D of the actual space this Scrollable3D can scroll through.
visibleOffset
Link copied to clipboard
common
abstract val visibleOffset: Position3D
Returns the offset where the visible part of this Scrollable3D starts.
visibleOffsetValue
Link copied to clipboard
common
abstract val visibleOffsetValue: ObservableValue<Position3D>
visibleSize
Link copied to clipboard
common
abstract val visibleSize: Size3D
Returns the size of the visible part of this Scrollable3D.

Inheritors

GameArea
Link copied to clipboard
BaseGameArea
Link copied to clipboard
DefaultScrollable3D
Link copied to clipboard

Sources

(source)
Link copied to clipboard