API DocumentationAll Packages | All Classes | Index | Frames
Class VisibilityConstraint
 
Packageorg.openzoom.flash.viewport.constraints
Classpublic final class VisibilityConstraint
ImplementsIViewportConstraint

Provides basic bounds checking by ensuring that a certain ratio of the scene is always visible.


Public Properties
 PropertyDefined by
  visibilityRatio : Number
Indicates the minimal ratio that has to visible of the scene.
VisibilityConstraint
Public Methods
 MethodDefined by
  
VisibilityConstraint()
Constructor.
VisibilityConstraint
  
validate(transform:IViewportTransform, target:IViewportTransform):IViewportTransform
Validate the viewport transform by performing transformations until it validates all constraints.
VisibilityConstraint
Property detail
visibilityRatioproperty
visibilityRatio:Number  [read-write]

Indicates the minimal ratio that has to visible of the scene.

Implementation
    public function get visibilityRatio():Number
    public function set visibilityRatio(value:Number):void
Constructor detail
VisibilityConstraint()constructor
public function VisibilityConstraint()

Constructor.

Method detail
validate()method
public function validate(transform:IViewportTransform, target:IViewportTransform):IViewportTransform

Validate the viewport transform by performing transformations until it validates all constraints.

Parameters
transform:IViewportTransform — IViewportTransform object to be validated.
 
target:IViewportTransform — IViewportTransform object that represents the last validated transform.

Returns
IViewportTransform — Validated IViewportTransform object.