# DpCubed

@Immutable inline class DpCubed : Comparable<DpCubed>

kotlin.Any | |

↳ | androidx.ui.unit.DpCubed |

Holds a unit of cubed dimensions, such as `1.value * 2.value * 3.dp`

. DpSquared,
DpCubed, and DpInverse are used primarily for Dp calculations to
ensure resulting units are as expected. Many times, Dp calculations use scalars to
determine the final dimension during calculation:
val width = oldWidth * stretchAmount
Other times, it is useful to do intermediate calculations with Dimensions directly:
val width = oldWidth * newTotalWidth / oldTotalWidth

## Summary

Public constructors | |
---|---|

Holds a unit of cubed dimensions, such as |

Public methods | |
---|---|

operator Int |
Support comparing DpCubed with comparison operators. |

operator DpCubed |
Divide a DpCubed by a scalar. |

operator DpSquared | |

operator Dp | |

operator Float |
Divide by a DpCubed to get a scalar result. |

operator DpCubed |
Subtract a DpCubed from another one. |

operator DpCubed |
Add two DpCubed together. |

operator DpCubed |
Multiply by a scalar to get a DpCubed result. |

String |
`toString()` |

Properties | |
---|---|

Float |

## Public constructors

### <init>

DpCubed(value: Float)

Holds a unit of cubed dimensions, such as `1.value * 2.value * 3.dp`

. DpSquared,
DpCubed, and DpInverse are used primarily for Dp calculations to
ensure resulting units are as expected. Many times, Dp calculations use scalars to
determine the final dimension during calculation:
val width = oldWidth * stretchAmount
Other times, it is useful to do intermediate calculations with Dimensions directly:
val width = oldWidth * newTotalWidth / oldTotalWidth

## Public methods

### compareTo

@Stable operator fun compareTo(other: DpCubed): Int

Support comparing DpCubed with comparison operators.

### div

@Stable inline operator fun div(other: DpCubed): Float

Divide by a DpCubed to get a scalar result.

### minus

@Stable inline operator fun minus(dimension: DpCubed): DpCubed

Subtract a DpCubed from another one.

### times

@Stable inline operator fun times(other: Float): DpCubed

Multiply by a scalar to get a DpCubed result.

### toString

@Stable fun toString(): String

## Properties

### value

val value: Float