VisibleBounds

View source
Entity → ceramic.VisibleBounds (Class)
Implements: Component

A component that displays the visible bounds of a visual entity.

VisibleBounds is a debugging utility that overlays a visual representation of an entity's bounding box. This is useful for:

  • Debugging layout and positioning issues
  • Visualizing collision boundaries
  • Understanding the actual size of transformed visuals
  • Checking alignment and spacing

The component automatically updates the bounds visual to match the entity's current dimensions, making it ideal for dynamic content.

// Add a red border to show bounds
var border = new Quad();
border.color = Color.RED;
border.borderWidth = 2;
border.transparent = true;

var boundsComponent = new VisibleBounds(border);
myVisual.component('bounds', boundsComponent);

// Remove bounds display
myVisual.removeComponent('bounds');
See: Visual The visual entities this component can be attached to, Component The component interface this class implements

Instance Members

entity: Visual

The visual entity this component is attached to. Set automatically when the component is bound.

initializerName: String
new(bounds: Visual): Void

Creates a new VisibleBounds component.

Name Type Description
bounds Visual The visual to use for displaying bounds. Common choices: - Quad with borderWidth for outlines - Quad with alpha < 1 for semi-transparent overlay - Mesh for custom bounds visualization * haxe // Create bounds with dashed line (using a texture) var dashedQuad = new Quad(); dashedQuad.texture = dashedLineTexture; var bounds = new VisibleBounds(dashedQuad);

Private Members

bounds: Visual

The visual used to display the bounds. This visual is added as a child to the entity and resized to match the entity's dimensions.

bindAsComponent(): Void

Called when this component is attached to an entity.

Sets up the bounds visual as a child of the entity and starts listening for update events to sync the bounds size. The bounds are immediately updated to match the entity.

updateBounds(delta: Float): Void

Updates the bounds visual to match the entity's dimensions.

Called every frame to ensure the bounds accurately reflect the entity's current size. The bounds visual is positioned at (0,0) relative to the entity and sized to match exactly.

Name Type Description
delta Float Time elapsed since last frame (unused but required by update callback)
setEntity(entity: Entity): Void
Name Type
entity Entity
getEntity(): Entity
Returns
Entity

Metadata

Name Parameters
:build ceramic.macros.ComponentMacro.build()
:autoBuild ceramic.macros.ComponentMacro.build()
:build ceramic.macros.EntityMacro.buildForCompletion()
:autoBuild ceramic.macros.EntityMacro.buildForCompletion()
:build tracker.macros.EventsMacro.build()
:autoBuild tracker.macros.EventsMacro.build()