get_paint_box


Description:

[ Version ( since = "1.6" ) ]
public bool get_paint_box (out ActorBox box)

Retrieves the paint volume of the passed Actor, and transforms it into a 2D bounding box in stage coordinates.

This function is useful to determine the on screen area occupied by the actor. The box is only an approximation and may often be considerably larger due to the optimizations used to calculate the box. The box is never smaller though, so it can reliably be used for culling.

There are times when a 2D paint box can't be determined, e.g. because the actor isn't yet parented under a stage or because the actor is unable to determine a paint volume.

Parameters:

this

a Actor

box

return location for a ActorBox

Returns:

true if a 2D paint box could be determined, else false.