Packagecom.degrafa.paint
Classpublic class VideoFill
InheritanceVideoFill Inheritance DegrafaObject
ImplementsIBlend, IGraphicsFill, ITransformablePaint

VideoFill is an advanced paint class used to fill an area with playing Video content.

Default MXML Propertysource



Public Properties
 PropertyDefined by
  alpha : Number
an alpha property that will be applied to this fill.
VideoFill
  blendMode : String
VideoFill
  coordinateType : String
VideoFill
 Inheriteddocument : Object
The MXML document that created this object.
DegrafaObject
 InheritedenableEvents : Boolean
Enable events for this object.
DegrafaObject
 InheritedhasEventManager : Boolean
Tests to see if a EventDispatcher instance has been created for this object.
DegrafaObject
  height : Number
The height to be used for scaling the video content rectangle (excluding any pixelMargin setting on the VideoStream source).
VideoFill
 Inheritedid : String
The identifier used by document to refer to this object.
DegrafaObject
  insetFromStroke : Boolean
whether the fillrendering bounds are determined by insetting from half the stroke width of the target or not.
VideoFill
 InheritedisInitialized : Boolean
DegrafaObject
  lastArgs : Array
[read-only] Provide access to the lastArgs array
VideoFill
  lastRectangle : Rectangle
[read-only] Provides access to the last rectangle that was relevant for this fill.
VideoFill
  loadingLocation : LoadingLocation
Optional loadingLocation reference.
VideoFill
 Inheritedname : String
The name that refers to this object.
DegrafaObject
 InheritedobjectBindings : Array
DegrafaObject
 Inheritedparent : IDegrafaObject
The current degrafa object parent.
DegrafaObject
  repeatX : String
How the bitmap repeats horizontally.
VideoFill
  repeatY : String
How the bitmap repeats vertically.
VideoFill
  restartFunction : Function
[read-only] Provides quick access to a cached function for restarting the last used fill either in the last used context, or, if a context is provided as an argument, then to an alternate context.
VideoFill
  rotation : Number
The number of degrees to rotate the bitmap.
VideoFill
  scaleX : Number
The percent to horizontally scale the video when filling, from 0.0 to 1.0.
VideoFill
  scaleY : Number
The percent to vertically scale the video when filling, from 0.0 to 1.0.
VideoFill
  smooth : Boolean
A flag indicating whether to smooth the video image when filling with it if scaling is applied.
VideoFill
  source : Object
The source used for the Video fill.
VideoFill
 InheritedsuppressEventProcessing : Boolean
Temporarily suppress event processing for this object.
DegrafaObject
  targetSetting : String
A 'smart'/quick setting for matching fill rendering between source and target.
VideoFill
  targetSettingOptions : Array
[static][read-only] targetSetting options, avalailable as a convenience.
VideoFill
  transform : ITransform
Defines the transform object that will be used for altering this VideoFill object.
VideoFill
  waiting : Boolean
A support property for binding to in the event of an external loading wait.
VideoFill
  width : Number
The width to be used for scaling the video content rectangle (excluding any pixelMargin setting on the VideoStream source).
VideoFill
  x : Number
The x-axis coordinate of the upper left point of the video content rectangle.
VideoFill
  y : Number
The y-axis coordinate of the upper left point of the video content rectangle.
VideoFill
Protected Properties
 PropertyDefined by
  _coordType : String = "relative"
VideoFill
 InheritedeventDispatcher : EventDispatcher
EventDispatcher instance for this object.
DegrafaObject
Public Methods
 MethodDefined by
  
VideoFill(source:Object = null, loc:LoadingLocation = null)
VideoFill
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
DegrafaObject
  
begin(graphics:Graphics, rc:Rectangle):void
Begins the Videofill.
VideoFill
 Inherited
dispatchEvent(evt:Event):Boolean
Dispatches an event into the event flow.
DegrafaObject
 Inherited
dispatchPropertyChange(bubbles:Boolean = false, property:Object = null, oldValue:Object = null, newValue:Object = null, source:Object = null):Boolean
Dispatches an property change event into the event flow.
DegrafaObject
  
end(graphics:Graphics):void
Ends the Video fill.
VideoFill
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
DegrafaObject
 Inherited
initChange(property:String, oldValue:Object, newValue:Object, source:Object):void
Helper function for dispatching property changes
DegrafaObject
 Inherited
initialized(document:Object, id:String):void
Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
DegrafaObject
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
DegrafaObject
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
DegrafaObject
Events
 EventSummaryDefined by
 Inherited  DegrafaObject
 Inherited  DegrafaObject
Public Constants
 ConstantDefined by
  CENTER_TO_TARGET : String = "centerToTarget"
[static]
VideoFill
  MATCH_BOUNDS : String = "matchTargetBounds"
[static]
VideoFill
  MATCH_BOUNDS_MAINTAIN_AR : String = "matchTargetBoundsMaintainAspectRatio"
[static]
VideoFill
  NONE : String = "none"
[static]
VideoFill
  REPEAT : String = "repeat"
[static]
VideoFill
  STRETCH : String = "stretch"
[static]
VideoFill
Property detail
alphaproperty
alpha:Number  [read-write]

an alpha property that will be applied to this fill.

This property can be used as the source for data binding.

Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
blendModeproperty 
blendMode:String  [read-write]

This property can be used as the source for data binding.

Implementation
    public function get blendMode():String
    public function set blendMode(value:String):void
coordinateTypeproperty 
coordinateType:String  [read-write]Implementation
    public function get coordinateType():String
    public function set coordinateType(value:String):void
_coordTypeproperty 
protected var _coordType:String = "relative"
heightproperty 
height:Number  [read-write]

The height to be used for scaling the video content rectangle (excluding any pixelMargin setting on the VideoStream source).

Implementation
    public function get height():Number
    public function set height(value:Number):void
insetFromStrokeproperty 
insetFromStroke:Boolean  [read-write]

whether the fillrendering bounds are determined by insetting from half the stroke width of the target or not. this setting only has effect when used to fill degrafa target geometry otherwise it is ignored.

Implementation
    public function get insetFromStroke():Boolean
    public function set insetFromStroke(value:Boolean):void
lastArgsproperty 
lastArgs:Array  [read-only]

Provide access to the lastArgs array

Implementation
    public function get lastArgs():Array
lastRectangleproperty 
lastRectangle:Rectangle  [read-only]

Provides access to the last rectangle that was relevant for this fill.

Implementation
    public function get lastRectangle():Rectangle
loadingLocationproperty 
loadingLocation:LoadingLocation  [read-write]

Optional loadingLocation reference. Only relevant when a subsequent source assignment is made as a url string. Using a LoadingLocation simplifies management of loading from external domains and is required if a crossdomain policy file is not in the default location (web root) and with the default name (crossdomain.xml) In actionscript, a loadingLocation assignment MUST precede a change in the url assigned to the source property If a LoadingLocation is being used, the url assigned to the source property MUST be relative to the base path defined in the LoadingLocation, otherwise loading will fail. If a LoadingLocation is NOT used and the source property assignment is an external domain url, then the crossdomain permissions must exist in the default location and with the default name crossdomain.xml, otherwise loading will fail.

Implementation
    public function get loadingLocation():LoadingLocation
    public function set loadingLocation(value:LoadingLocation):void
repeatXproperty 
repeatX:String  [read-write]

How the bitmap repeats horizontally. Valid values are "none", "repeat", and "stretch". Setting this value to "repeat" if repeatY is "none" will automatically set repeatY to "repeat" also. If targetSetting is set to a value other than "none" then both repeatX and repeatY must be set to "repeat" to enable repeating If targetSetting is set to a value other than "none" then values of "stretch" are ignored for repeatX or repeatY

The default value is "none".

This property can be used as the source for data binding.

Implementation
    public function get repeatX():String
    public function set repeatX(value:String):void
repeatYproperty 
repeatY:String  [read-write]

How the bitmap repeats vertically. Valid values are "none", "repeat", and "stretch". Setting this value to "repeat" if repeatX is "none" will automatically set repeatX to "repeat" also. If targetSetting is set to a value other than "none" then both repeatX and repeatY must be set to "repeat" to enable repeating If targetSetting is set to a value other than "none" then values of "stretch" are ignored for repeatX or repeatY

The default value is "none".

This property can be used as the source for data binding.

Implementation
    public function get repeatY():String
    public function set repeatY(value:String):void
restartFunctionproperty 
restartFunction:Function  [read-only]

Provides quick access to a cached function for restarting the last used fill either in the last used context, or, if a context is provided as an argument, then to an alternate context. If no last used context is available then this will do nothing;

Implementation
    public function get restartFunction():Function
rotationproperty 
rotation:Number  [read-write]

The number of degrees to rotate the bitmap. Valid values range from 0.0 to 360.0.

The default value is 0.

This property can be used as the source for data binding.

Implementation
    public function get rotation():Number
    public function set rotation(value:Number):void
scaleXproperty 
scaleX:Number  [read-write]

The percent to horizontally scale the video when filling, from 0.0 to 1.0. If 1.0, the video is filled at its natural size.

The default value is 1.0.

This property can be used as the source for data binding.

Implementation
    public function get scaleX():Number
    public function set scaleX(value:Number):void
scaleYproperty 
scaleY:Number  [read-write]

The percent to vertically scale the video when filling, from 0.0 to 1.0. If 1.0, the video is filled at its natural size.

The default value is 1.0.

This property can be used as the source for data binding.

Implementation
    public function get scaleY():Number
    public function set scaleY(value:Number):void
smoothproperty 
smooth:Boolean  [read-write]

A flag indicating whether to smooth the video image when filling with it if scaling is applied.

The default value is true.

This property can be used as the source for data binding.

Implementation
    public function get smooth():Boolean
    public function set smooth(value:Boolean):void
sourceproperty 
source:Object  [read-write]

The source used for the Video fill. The source can either be a VideoStream instance or a url.
NOT YET FUNCTIONING (BUT COMING):A url string, if used, can be either a relative url (relative within the local domain or relative to a LoadingLocation specified in the loadingLocation property) or absolute with no LoadingLocation (see loadingLocation property)

This property can be used as the source for data binding.

Implementation
    public function get source():Object
    public function set source(value:Object):void
targetSettingproperty 
targetSetting:String  [read-write]

A 'smart'/quick setting for matching fill rendering between source and target. Using this setting overrides - or more precisely, ignores - most of the manual settings applied to the fill. Using 'none' enables all the regular manual settings

Implementation
    public function get targetSetting():String
    public function set targetSetting(value:String):void
targetSettingOptionsproperty 
targetSettingOptions:Array  [read-only]

targetSetting options, avalailable as a convenience.

Implementation
    public static function get targetSettingOptions():Array
transformproperty 
transform:ITransform  [read-write]

Defines the transform object that will be used for altering this VideoFill object.

This property can be used as the source for data binding.

Implementation
    public function get transform():ITransform
    public function set transform(value:ITransform):void
waitingproperty 
waiting:Boolean  [read-write]

A support property for binding to in the event of an external loading wait. permits a simple binding to indicate that the wait is over

This property can be used as the source for data binding.

Implementation
    public function get waiting():Boolean
    public function set waiting(value:Boolean):void
widthproperty 
width:Number  [read-write]

The width to be used for scaling the video content rectangle (excluding any pixelMargin setting on the VideoStream source).

Implementation
    public function get width():Number
    public function set width(value:Number):void
xproperty 
x:Number  [read-write]

The x-axis coordinate of the upper left point of the video content rectangle. If not specified a default value of 0 is used.

Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number  [read-write]

The y-axis coordinate of the upper left point of the video content rectangle. If not specified a default value of 0 is used.

Implementation
    public function get y():Number
    public function set y(value:Number):void
Constructor detail
VideoFill()constructor
public function VideoFill(source:Object = null, loc:LoadingLocation = null)Parameters
source:Object (default = null)
 
loc:LoadingLocation (default = null)
Method detail
begin()method
public function begin(graphics:Graphics, rc:Rectangle):void

Begins the Videofill.

Parameters
graphics:Graphics
 
rc:Rectangle
end()method 
public function end(graphics:Graphics):void

Ends the Video fill.

Parameters
graphics:Graphics
Constant detail
CENTER_TO_TARGETconstant
public static const CENTER_TO_TARGET:String = "centerToTarget"
MATCH_BOUNDSconstant 
public static const MATCH_BOUNDS:String = "matchTargetBounds"
MATCH_BOUNDS_MAINTAIN_ARconstant 
public static const MATCH_BOUNDS_MAINTAIN_AR:String = "matchTargetBoundsMaintainAspectRatio"
NONEconstant 
public static const NONE:String = "none"
REPEATconstant 
public static const REPEAT:String = "repeat"
STRETCHconstant 
public static const STRETCH:String = "stretch"