The base class for all objects that can be placed on the display list.

Use the DisplayObjectContainer class to arrange the display objects in the display list. DisplayObjectContainer objects can have child display objects, while other display objects, such as Shape and TextField objects, are "leaf" nodes that have only parents and siblings, no children.

The DisplayObject class supports basic functionality like the x and y position of an object, as well as more advanced properties of the object such as its transformation matrix.

The DisplayObject class itself does not include any APIs for rendering content onscreen. For that reason, if you want to create a custom subclass of the DisplayObject class, you will want to extend one of its subclasses that do have APIs for rendering content onscreen, such as the Shape, Sprite, Bitmap, SimpleButton, TextField, or MovieClip class.

The DisplayObject class contains several BroadcastEvents. Normally, the target of any particular event is a specific DisplayObject instance. For example, the target of an added event is the specific DisplayObject instance that was added to the display list. Having a single target restricts the placement of event listeners to that target and in some cases the target's ancestors on the display list. With BroadcastEvents, however, the target is not a specific DisplayObject instance, but rather all DisplayObject instances, including those that are not on the display list. This means that you can add a listener to any DisplayObject instance to listen for BroadcastEvents.

Inheritance
Implements
  • RenderObject
  • TweenObject2D
  • BitmapDrawable
Implemented by

Constants

addedEvent → EventStreamProvider<Event>

const EventStreamProvider<Event>(Event.ADDED)
addedToStageEvent → EventStreamProvider<Event>

const EventStreamProvider<Event>(Event.ADDED_TO_STAGE)
enterFrameEvent → EventStreamProvider<EnterFrameEvent>

const EventStreamProvider<EnterFrameEvent>(Event.ENTER_FRAME)
exitFrameEvent → EventStreamProvider<ExitFrameEvent>

const EventStreamProvider<ExitFrameEvent>(Event.EXIT_FRAME)
removedEvent → EventStreamProvider<Event>

const EventStreamProvider<Event>(Event.REMOVED)
removedFromStageEvent → EventStreamProvider<Event>

const EventStreamProvider<Event>(Event.REMOVED_FROM_STAGE)
renderEvent → EventStreamProvider<RenderEvent>

const EventStreamProvider<RenderEvent>(Event.RENDER)

Constructors

DisplayObject()

Properties

alpha → num

The alpha transparency value of the object specified.

read / write
blendMode → BlendMode

A value from the BlendMode class that specifies which blend mode to use.

read / write
bounds → Rectangle<num>

Returns a rectangle that defines the area of this display object in this display object's local coordinates.

read-only
boundsTransformed → Rectangle<num>

Returns a rectangle that defines the area of this display object in this display object's parent coordinates.

read-only
cache → RenderTextureQuad

This getter gives you access to the underlying RenderTextureQuad if a cache is applied to this display object. If no cache is applied this value is ´null´.

read-only
displayObjectID → int

read-only
filters → List<BitmapFilter>

The filters currently associated with this display object.

read / write
globalTransformationMatrix → Matrix

The global 2D transformation matrix of this display object.

read-only
globalTransformationMatrix3D → Matrix3D

The global 3D transformation matrix of this display object.

read-only
hashCode → int

Get a hash code for this object.

read-only, inherited
height → num

The height of this display object with the applied transformation.

read / write
mask → Mask

The calling display object is masked by the specified mask object.

read / write
mousePosition → Point<num>

The position of the mouse relative to the local coordinate system of the display object.

read-only
mouseX → num

The x-coordinate of the mouse relative to the local coordinate system of the display object.

read-only
mouseY → num

The y-coordinate of the mouse relative to the local coordinate system of the display object.

read-only
name → String

The instance name of this display object.

read / write
off → bool

The availability and visibility of the display object.

read / write
onAdded → EventStream<Event>

Dispatched when a display object is added to the display list.

read-only
onAddedToStage → EventStream<Event>

Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.

read-only
onEnterFrame → EventStream<EnterFrameEvent>

Dispatched when a frame is entered.

read-only
onExitFrame → EventStream<ExitFrameEvent>

Dispatched when a frame is exited. All frame scripts have been run.

read-only
onRemoved → EventStream<Event>

Dispatched when a display object is about to be removed from the display list.

read-only
onRemovedFromStage → EventStream<Event>

Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.

read-only
onRender → EventStream<RenderEvent>

Dispatched when the display list is about to be updated and rendered.

read-only
parent → DisplayObjectParent

The DisplayObjectContainer object that contains this display object.

read-only
pivotX → num

The x-coordinate of the pivot point of this display object.

read / write
pivotY → num

The y-coordinate of the pivot point of this display object.

read / write
root → DisplayObject

The top-most display object in the portion of the display list's tree structure.

read-only
rotation → num

The rotation of this display object, in radians, from its original orientation.

read / write
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited
scaleX → num

The horizontal scale (percentage) of the object as applied from the pivot point.

read / write
scaleY → num

The vertical scale (percentage) of the object as applied from the pivot point.

read / write
skewX → num

The horizontal skew of this object.

read / write
skewY → num

The vertical skew of this object.

read / write
stage → Stage

The Stage of this display object.

read-only
transformationMatrix → Matrix

The transformation matrix of this display object relative to this display object's parent.

read-only
userData → dynamic

The user-defined data associated with this display object.

read / write
visible → bool

The visibility and availability of the display object.

read / write
width → num

The width of this display object with the applied transformation.

read / write
x → num

The x-coordinate of is display object relative to the local coordinates of the parent DisplayObjectContainer.

read / write
y → num

The y-coordinate of this display object relative to the local coordinates of the parent DisplayObjectContainer.

read / write

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

addEventListener(String eventType, EventListener eventListener, { bool useCapture: false, int priority: 0 }) → StreamSubscription<Event>

Adds an event listener to receive events.

inherited
addTo(DisplayObjectParent parent) → void

Add this display object to the specified parent.

alignPivot([HorizontalAlign hAlign = HorizontalAlign.Center, VerticalAlign vAlign = VerticalAlign.Center ]) → void

Aligns the display object's pivot point relative to the current bounds.

applyCache(num x, num y, num width, num height, { bool debugBorder: false, num pixelRatio: 1.0 }) → void

Draws the specified area of this display object to an internal render texture and the engine will use this texture to optimize performance.

dispatchEvent(Event event) → void

Dispatches the event to all listening subscribers.

dispatchEventRaw(Event event, EventDispatcher target, EventPhase eventPhase) → void

Do not use the dispatchEventRaw method unless you want to override the way how events are dispatched for display list object. Please use dispatchEvent instead.

inherited
getBounds(DisplayObject targetSpace) → Rectangle<num>

Returns the bounds of this display object relative to the specified targetSpace.

getTransformationMatrix(DisplayObject targetSpace) → Matrix

The 2D transformation matrix relative to the given targetSpace.

getTransformationMatrix3D(DisplayObject targetSpace) → Matrix3D

The 3D transformation matrix relative to the given targetSpace.

globalToLocal(Point<num> globalPoint, [ Point<num> returnPoint ]) → Point<num>

Converts the point object from the Stage's global coordinates to this display object's local coordinates.

hasEventListener(String eventType, { bool useCapture: false }) → bool

Returns true if the EventDispatcher has event listeners. The useCapture paramenter defines if the event listeners should be registered for the capturing event phase or not.

inherited
hitTestInput(num localX, num localY) → DisplayObject

Evaluates this display object to see if the coordinates localX and localY are inside this display object.

hitTestObject(DisplayObject other) → bool

Evaluates this display object to see if it overlaps or intersects with the bounding box of the other display object.

hitTestPoint(num x, num y, [ bool shapeFlag = false ]) → bool

Evaluates this display object to see if it overlaps or intersects with the point specified by the x and y parameters.

localToGlobal(Point<num> localPoint, [ Point<num> returnPoint ]) → Point<num>

Converts the point object from this display object's local coordinates to the Stage global coordinates.

localToParent(Point<num> localPoint, [ Point<num> returnPoint ]) → Point<num>

Converts the point object from this display object's local coordinates to this display object's parent coordinates.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
on<T extends Event>(String eventType) → EventStream<T>

Returns an event stream of type eventType.

inherited
parentToLocal(Point<num> parentPoint, [ Point<num> returnPoint ]) → Point<num>

Converts the point object from this display obejct's parent coordinates to this display object's local coordinates.

refreshCache() → void

Refreshes the cached area of this display object.

removeCache() → void

Removes the previously cached area of this display object.

removeEventListener(String eventType, EventListener eventListener, { bool useCapture: false }) → void

Removes an event listener to stop receiving events.

inherited
removeEventListeners(String eventType) → void

Removes all event listeners of a given event type.

inherited
removeFromParent() → void

Removes this display object from its parent.

render(RenderState renderState) → void

Renders this display object with the given renderState. The display object is rendered without its filters.

renderFiltered(RenderState renderState) → void

Renders this display object with the given renderState. The display object is rendered with its filters.

setTransform(num x, num y, [ num scaleX, num scaleY, num rotation, num skewX, num skewY, num pivotX, num pivotY ]) → void

Sets transformation properties.

toString() → String

Returns a string representation of this object.

inherited