bgw-gui/tools.aqua.bgw.components.gamecomponentviews/CardView

CardView

open class CardView( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_CARD_WIDTH, height: Number = DEFAULT_CARD_HEIGHT, front: Visual, back: Visual = front) : GameComponentView

A CardView may be used to visualize a card.

You can inherit from this class if you want to add additional functionality or fields. Inheriting does NOT change how a cardView is visualized by the BGW framework.

Visualization:

The Visual at the currentSide value is used to visualize the card. By default, the back side is shown.

Parameters

posX

Horizontal coordinate for this CardView. Default: 0.

posY

Vertical coordinate for this CardView. Default: 0.

width

Width for this CardView. Default: DEFAULT_CARD_WIDTH.

height

Height for this CardView. Default: DEFAULT_CARD_HEIGHT.

front

Visual to represent the front side of the card.

back

Visual to represent the back side of the card. Default: same Visual as front.

Constructors

CardView

fun CardView( posX: Number = 0, posY: Number = 0, width: Number = DEFAULT_CARD_WIDTH, height: Number = DEFAULT_CARD_HEIGHT, front: Visual, back: Visual = front)

Creates a CardView with given Visuals.

Types

CardSide

enum CardSide : Enum<CardView.CardSide>

Enum for the card sides FRONT and BACK with their visual indices.

Functions

flip

fun flip()

Flips the CardView by seting the currentSide to the other value.

offset

fun offset(offsetX: Number, offsetY: Number)

Adds an offset to this ComponentView's Position.

removeFromParent

fun removeFromParent(): ComponentView

Removes this component from its parent.

reposition

fun reposition(posX: Number, posY: Number)

Repositions this ComponentView to the specified coordinates.

resize

fun resize(width: Number, height: Number)

Resizes this ComponentView to the specified width and height.

rotate

fun rotate(degrees: Number)

Rotates this ComponentView by the given number of degrees.

scale

fun scale(scalar: Number)

Scales this ComponentView by the given scalar.

scaleX

fun scaleX(scalar: Number)

Scales this ComponentView's width by the given scalar.

scaleY

fun scaleY(scalar: Number)

Scales this ComponentView's height by the given scalar.

showBack

fun showBack()

Sets the currentSide to be displayed to CardSide.BACK.

showCardSide

fun showCardSide(side: CardView.CardSide)

Sets the currentSide to the parameter value.

showFront

fun showFront()

Sets the currentSide to be displayed to CardSide.FRONT.

toBack

fun toBack()

Puts the ComponentView to the back inside its parent and Changes its zIndex accordingly.

toFront

fun toFront()

Puts the ComponentView to the front inside its parent and Changes its zIndex accordingly.

Properties

actualHeight

var actualHeight: Double

The actual height for this ComponentView considering scale.

actualPosX

var actualPosX: Double

Horizontal position of this ComponentView considering scale.

actualPosY

var actualPosY: Double

Vertical position of this ComponentView considering scale.

actualWidth

var actualWidth: Double

The actual width for this ComponentView considering scale.

backVisual

var backVisual: Visual

Back Visual for this CardView.

currentSide

var currentSide: CardView.CardSide

The current CardSide that is displayed.

dropAcceptor

var dropAcceptor: (DragEvent) -> Boolean? = null

Returns whether this ComponentView is a valid drop target for the dragged component in the given DragEvent or not.

frontVisual

var frontVisual: Visual

Front Visual for this CardView.

height

var height: Double

The height for this ComponentView.

heightProperty

val heightProperty: DoubleProperty

Property for the height of this ComponentView.

isDisabled

var isDisabled: Boolean

Controls if user input events cause input functions of this ComponentView to get invoked.

isDisabledProperty

val isDisabledProperty: BooleanProperty

Property that controls if user input events cause input functions of this ComponentView to get invoked.

isDraggable

var isDraggable: Boolean

Controls whether component is draggable or not.

isDraggableProperty

val isDraggableProperty: BooleanProperty

Property that controls whether component is draggable or not.

isDragged

var isDragged: Boolean

Reflects whether component is currently dragged or not.

isDraggedProperty

val isDraggedProperty: ReadonlyBooleanProperty

Property that reflects whether component is currently dragged or not.

isFocusable

var isFocusable: Boolean

Controls whether this ComponentView is focusable or not.

isFocusableProperty

val isFocusableProperty: BooleanProperty

Property that controls whether this ComponentView is focusable or not.

isVisible

var isVisible: Boolean

Visibility of this ComponentView.

isVisibleProperty

val isVisibleProperty: BooleanProperty

Property for the visibility of this ComponentView.

layoutBounds

var layoutBounds: CoordinatePlain

Returns a CoordinatePlain containing the component's corner Coordinates and its layout bounds.

name

var name: String

Name field only for debugging purposes. Has no effect on rendering.

onDragDropped

var onDragDropped: (DragEvent) -> Unit? = null

Gets invoked with a DragEvent whenever a drag and drop gesture finishes over this ComponentView and the dropAcceptor returns true for the given DragEvent.