# ContainedObject

A supertype for objects that take up a rectangular area and have a mutable position that may be constrained by a larger object around them.

## Value members

### Inherited methods

Returns the object’s anchoring point, which is Anchor.Center unless overridden.

Returns the object’s anchoring point, which is Anchor.Center unless overridden.

- Inherited from:
- HasEdges

Returns the y coordinate of the bottom edge.

Returns the y coordinate of the bottom edge.

- Inherited from:
- HasEdges

Returns the coordinates of this object’s bottom left-hand corner.

Returns the coordinates of this object’s bottom left-hand corner.

- Inherited from:
- HasEdges

Returns the coordinates of this object’s bottom right-hand corner.

Returns the coordinates of this object’s bottom right-hand corner.

- Inherited from:
- HasEdges

Returns the average position between this object’s edges.

Returns the average position between this object’s edges.

- Inherited from:
- HasEdges

the location of this object’s center: the average point between its edges, expressed in coordinates relative to the object’s top left-hand corner

the location of this object’s center: the average point between its edges, expressed in coordinates relative to the object’s top left-hand corner

- Inherited from:
- HasSize

Looks for a position for this object that is as close to possible to the object’s
current pos but keeps the object’s edges within the bounds of the object’s
container. Returns that `Pos`

.

Looks for a position for this object that is as close to possible to the object’s
current pos but keeps the object’s edges within the bounds of the object’s
container. Returns that `Pos`

.

- Inherited from:
- HasContainer

Looks for a position for this object that is as close to possible to a particular target position but keeps the object’s edges within the bounds of the given other object.

Looks for a position for this object that is as close to possible to a particular target position but keeps the object’s edges within the bounds of the given other object.

- Value parameters:
- container
another object that sets the boundaries for the return value

- desiredPosition
the ideal position for this object (defaults to the object’s current pos)

- Returns:
the location closest to

`desiredPosition`

where this object’s anchor can be placed without its edges extending beyond`container`

- Inherited from:
- HasEdges

Looks for a position for this object that is as close to possible to the object’s
current pos but keeps the left and right edges of the object within the bounds
of the object’s container. Returns that `Pos`

.

Looks for a position for this object that is as close to possible to the object’s
current pos but keeps the left and right edges of the object within the bounds
of the object’s container. Returns that `Pos`

.

- Inherited from:
- HasContainer

Looks for a position for this object that is as close to possible to a particular target position but keeps the left and right edges of the object within the bounds of the given other object.

Looks for a position for this object that is as close to possible to a particular target position but keeps the left and right edges of the object within the bounds of the given other object.

- Value parameters:
- container
another object that sets the boundaries for the return value

- desiredPosition
the ideal position for this object (defaults to the object’s current pos)

- Returns:
the location closest to

`desiredPosition`

where this object’s anchor can be placed without its left or right edge extending beyond`container`

- Inherited from:
- HasEdges

Looks for a position for this object that is as close to possible to the object’s
current pos but keeps the top and bottom edges of the object within the bounds
of the object’s container. Returns that `Pos`

.

Looks for a position for this object that is as close to possible to the object’s
current pos but keeps the top and bottom edges of the object within the bounds
of the object’s container. Returns that `Pos`

.

- Inherited from:
- HasContainer

Looks for a position for this object that is as close to possible to a particular target position but keeps the top and bottom edges of the object within the bounds of the given other object.

Looks for a position for this object that is as close to possible to a particular target position but keeps the top and bottom edges of the object within the bounds of the given other object.

- Value parameters:
- container
another object that sets the boundaries for the return value

- desiredPosition
the ideal position for this object (defaults to the object’s current pos)

- Returns:
the location closest to

`desiredPosition`

where this object’s anchor can be placed without its top or bottom edge extending beyond`container`

- Inherited from:
- HasEdges

Returns the position within this object’s edges that is as close as possible to the given position.

Returns the position within this object’s edges that is as close as possible to the given position.

- Inherited from:
- HasEdges

Determines whether the given `Pos`

’s x coordinate is between this object’s left edge (inclusive)
and its right edge (exclusive) and if it’s y coordinate is similarly between the top and bottom edges.

Determines whether the given `Pos`

’s x coordinate is between this object’s left edge (inclusive)
and its right edge (exclusive) and if it’s y coordinate is similarly between the top and bottom edges.

- Inherited from:
- HasEdges

Determines the distance (“as the crow flies”) between this object’s `pos`

and that of the given object.

Determines the distance (“as the crow flies”) between this object’s `pos`

and that of the given object.

- Inherited from:
- HasPos

this object’s height: the distance from its top edge to its bottom edge

this object’s height: the distance from its top edge to its bottom edge

- Inherited from:
- HasSize

Returns the x coordinate of the anchoring point within this object, relative to the object’s left edge.

Returns the x coordinate of the anchoring point within this object, relative to the object’s left edge.

- Inherited from:
- HasAnchor

Returns the y coordinate of the anchoring point within this object, relative to the object’s top edge.

Returns the y coordinate of the anchoring point within this object, relative to the object’s top edge.

- Inherited from:
- HasAnchor

Returns the x coordinate of this object’s left edge.

Returns the x coordinate of this object’s left edge.

- Inherited from:
- HasEdges

Returns the x coordinate of the right edge.

Returns the x coordinate of the right edge.

- Inherited from:
- HasEdges

Returns the y coordinate of the top edge.

Returns the y coordinate of the top edge.

- Inherited from:
- HasEdges

Returns the coordinates of this object’s top left-hand corner.

Returns the coordinates of this object’s top left-hand corner.

- Inherited from:
- HasEdges

Returns the coordinates of this object’s top right-hand corner.

Returns the coordinates of this object’s top right-hand corner.

- Inherited from:
- HasEdges