FloatSize3d


class FloatSize3d


Size of a 3d object represented as a Float, such as the dimensions of a spatial volume in meters.

Summary

Public companion functions

FloatSize3d

Creates a FloatSize3d from a Vector3, using the Vector3's x, y, and z components as the width, height, and depth respectively.

Public constructors

FloatSize3d(width: Float, height: Float, depth: Float)

Public functions

operator FloatSize3d
div(divisor: Float)

Returns a new FloatSize3d that's uniformly divided by the divisor.

operator FloatSize3d
div(divisor: Int)

Returns a new FloatSize3d that's uniformly divided by the divisor.

open operator Boolean
equals(other: Any?)
open Int
operator FloatSize3d
times(scalar: Float)

Returns a new FloatSize3d that's uniformly multiplied by the scalar.

operator FloatSize3d
times(scalar: Int)

Returns a new FloatSize3d that's uniformly multiplied by the scalar.

FloatSize2d

Returns a new FloatSize2d with the same width and height as this FloatSize3d.

open String

Public properties

Float

the depth of the object

Float

the height of the object

Float

the width of the object

Public companion functions

fromVector3

Added in 1.0.0-alpha10
fun fromVector3(vector: Vector3): FloatSize3d

Creates a FloatSize3d from a Vector3, using the Vector3's x, y, and z components as the width, height, and depth respectively.

Parameters
vector: Vector3

the source Vector3

Returns
FloatSize3d

a new FloatSize3d instance

Public constructors

FloatSize3d

Added in 1.0.0-alpha10
FloatSize3d(width: Float = 0.0f, height: Float = 0.0f, depth: Float = 0.0f)

Public functions

div

Added in 1.0.0-alpha10
operator fun div(divisor: Float): FloatSize3d

Returns a new FloatSize3d that's uniformly divided by the divisor.

Parameters
divisor: Float

the value to divide the width, height, and depth by

Returns
FloatSize3d

a new FloatSize3d with the divided dimensions

div

Added in 1.0.0-alpha10
operator fun div(divisor: Int): FloatSize3d

Returns a new FloatSize3d that's uniformly divided by the divisor.

Parameters
divisor: Int

the value to divide the width, height, and depth by

Returns
FloatSize3d

a new FloatSize3d with the divided dimensions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

times

Added in 1.0.0-alpha10
operator fun times(scalar: Float): FloatSize3d

Returns a new FloatSize3d that's uniformly multiplied by the scalar.

Parameters
scalar: Float

the value to multiply the width, height, and depth by

Returns
FloatSize3d

a new FloatSize3d with the multiplied dimensions

times

Added in 1.0.0-alpha10
operator fun times(scalar: Int): FloatSize3d

Returns a new FloatSize3d that's uniformly multiplied by the scalar.

Parameters
scalar: Int

the value to multiply the width, height, and depth by

Returns
FloatSize3d

a new FloatSize3d with the multiplied dimensions

to2d

Added in 1.0.0-alpha10
fun to2d(): FloatSize2d

Returns a new FloatSize2d with the same width and height as this FloatSize3d.

toString

open fun toString(): String

Public properties

depth

Added in 1.0.0-alpha10
val depthFloat

the depth of the object

height

Added in 1.0.0-alpha10
val heightFloat

the height of the object

width

Added in 1.0.0-alpha10
val widthFloat

the width of the object