Dart Documentationbot_retainedSpriteElement

SpriteElement class

Extends

DisposableImpl > AttachableObject > PElement > ImgElement > SpriteElement

Constructors

new SpriteElement(ImageElement image, num width, num height, Coordinate startCoordinate, Vector nextDelta, int count) #

SpriteElement(ImageElement image, num width, num height,
              this.startCoordinate, this.nextDelta, this.count) :
  super(width, height, image);

factory SpriteElement.horizontalFromUrl(String src, num w, num h, int count, num xDelta, [Coordinate start = const Coordinate()]) #

factory SpriteElement.horizontalFromUrl(String src, num w, num h,
    int count, num xDelta, [Coordinate start = const Coordinate()]) {
  final img = new ImageElement(src, null, null);

  return new SpriteElement(img, w, h, start, new Vector(xDelta, 0), count);
}

Fields

final bool cacheEnabled #

inherited from PElement
final bool cacheEnabled;

bool clip #

inherited from PElement
bool clip = false;

final int count #

final int count;

final Vector nextDelta #

final Vector nextDelta;

final Coordinate startCoordinate #

final Coordinate startCoordinate;

Methods

bool operator ==(other) #

inherited from Object

The equality operator.

The default behavior for all Objects is to return true if and only if this and other are the same object.

If a subclass overrides the equality operator it should override the hashCode method as well to maintain consistency.

bool operator ==(other) => identical(this, other);

AffineTransform addTransform() #

inherited from PElement
AffineTransform addTransform(){
  validateNotDisposed();
  var tx = new AffineTransform();
  _transforms.add(tx);
  return tx;
}

void dispose() #

inherited from DisposableImpl
void dispose(){
  if (!_disposed) {
    // Set disposed_ to true first, in case during the chain of disposal this
    // gets disposed recursively.
    this._disposed = true;
    this.disposeInternal();
  }
}

void disposeInternal() #

inherited from PElement

Do not call this method directly. Call dispose instead. Subclasses should override this method to implement Disposable behavior.

docs inherited from DisposableImpl
void disposeInternal(){
  super.disposeInternal();
  _updatedEventHandle.dispose();
  _invalidatedEventHandle.dispose();
}

bool draw(CanvasRenderingContext2D ctx) #

inherited from PElement
bool draw(CanvasRenderingContext2D ctx){
  update();
  var dirty = (_lastDrawSize == null);
  drawCore(ctx);
  return dirty;
}

void drawCore(CanvasRenderingContext2D ctx) #

inherited from PElement
void drawCore(CanvasRenderingContext2D ctx){
  if(cacheEnabled) {
    _drawCached(ctx);
  } else {
    _drawNormal(ctx);
  }
}

void drawOverride(CanvasRenderingContext2D ctx) #

inherited from ImgElement
void drawOverride(CanvasRenderingContext2D ctx) {
  if(_image.complete) {
    _doDraw(ctx);
  } else if(!_waitingOnLoad) {
    _waitingOnLoad = true;
    // TODO: some day we'll have a way to remove these cleanly
    //       ...because this handled should be disposed :-/
    _image.on.load.add(_onImageLoad);
  }
}

AffineTransform getTransform() #

inherited from PElement
AffineTransform getTransform() {
  var tx = new AffineTransform();
  _transforms.forEach(tx.concatenate);
  return tx;
}

AffineTransform getTransformToRoot() #

inherited from PElement
AffineTransform getTransformToRoot(){
  var tx = new AffineTransform();
  if(_parent != null){
    tx.concatenate(_parent.getTransformToRoot());
  }
  tx.concatenate(getTransform());
  return tx;
}

PElement getVisualChild(int index) #

inherited from PElement
PElement getVisualChild(int index){
  throw "no children for this type";
}

int hashCode() #

inherited from Object

Get a hash code for this object.

All objects have hash codes. Hash codes are guaranteed to be the same for objects that are equal when compared using the equality operator ==. Other than that there are no guarantees about the hash codes. They will not be consistent between runs and there are no distribution guarantees.

If a subclass overrides hashCode it should override the equality operator as well to maintain consistency.

external int hashCode();

bool hasVisualChild(PElement element) #

inherited from PElement
bool hasVisualChild(PElement element){
  var length = visualChildCount;
  for(var i=0;i<length;i++){
    if(identical(element, getVisualChild(i))){
      return true;
    }
  }
  return false;
}

num get height() #

inherited from PElement
num get height => _height;

void set height(num value) #

inherited from PElement
void set height(num value) {
  assert(isValidNumber(value));
  _height = value;
  invalidateDraw();
}

EventRoot<EventArgs> get invalidated() #

inherited from PElement
EventRoot<EventArgs> get invalidated => _invalidatedEventHandle;

void invalidateDraw() #

inherited from PElement
void invalidateDraw(){
  validateNotDisposed();
  if(_lastDrawSize != null){
    _lastDrawSize = null;
    _invalidateParent();
  }
}

bool get isDisposed() #

inherited from DisposableImpl
bool get isDisposed => _disposed;

void nextFrame() #

void nextFrame() {
  setFrame(_frame + 1);
}

noSuchMethod(String name, List args) #

inherited from Object

noSuchMethod is invoked when users invoke a non-existant method on an object. The name of the method and the arguments of the invocation are passed to noSuchMethod. If noSuchMethod returns a value, that value becomes the result of the original invocation.

The default behavior of noSuchMethod is to throw a noSuchMethodError.

external Dynamic noSuchMethod(String name, List args);

ElementParent get parent() #

inherited from PElement
ElementParent get parent => _parent;

void previousFrame() #

void previousFrame() {
  setFrame(_frame - 1);
}

void registerParent(ElementParent parent) #

inherited from PElement
void registerParent(ElementParent parent) {
  assert(_parent == null);
  assert(parent != null);
  _parent = parent;
}

Type get runtimeType() #

inherited from Object

A representation of the runtime type of the object.

external Type get runtimeType;

void setFrame(int frame) #

void setFrame(int frame) {
  _frame = (frame % count);
  invalidateDraw();
}

Size get size() #

inherited from PElement
Size get size => new Size(_width, _height);

void set size(Size value) #

inherited from PElement
void set size(Size value) {
  assert(value.isValid);
  _width = value.width;
  _height = value.height;
  invalidateDraw();
}

String toString() #

inherited from Object

Returns a string representation of this object.

external String toString();

void update() #

inherited from PElement
void update(){
  _updatedEventHandle.fireEvent(EventArgs.empty);
}

EventRoot<EventArgs> get updated() #

inherited from PElement
EventRoot<EventArgs> get updated => _updatedEventHandle;

void validateNotDisposed() #

inherited from DisposableImpl
void validateNotDisposed() {
  assert(!_disposed);
}

int get visualChildCount() #

inherited from PElement
int get visualChildCount => 0;

num get width() #

inherited from PElement
num get width => _width;

void set width(num value) #

inherited from PElement
void set width(num value) {
  assert(isValidNumber(value));
  _width = value;
  invalidateDraw();
}