Scroller Min and Max Position #6
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… coordinates of a scroller. This functionality is added now.
| package misc { import misc.*; import flash.display.*; import flash.events.*; import flash.utils.*; import flash.geom.*; import flash.ui.*; /** * A simple class to handle level / world scrolling, such as in sidescrollers. movement occurs by setting a "focus" * object (that is a descendent display object) to keep centered on the screen. * NOTE: Currently this class assumes that it does not have an ancestors between it and the stage with * any transformations. For example if the parent is offset by 100x100, the focus object will be offset that much * from the center of the stage. * TO DO: More robust scrolling. Maybe multiple "focus objects" to all be kept on the screen at once, scaling in-and-out * to make them all fit? Clamp scrolling to certain bounds? Better tweening? */ public class Scroller extends Entity { /// Path / name of a display object to set "focus" to on creation. NOTE: An ScrollerChilds with focusOn == true /// will override this value. [Inspectable(defaultValue='')] public var focusOn:String = ''; /// Nudge the viewport based on the position of the mouse. 0 = no nudging. 1 = nudge the size of the stage. [Inspectable(defaultValue=0)] public var mouseNudgeX:Number = 0; [Inspectable(defaultValue=0)] public var mouseNudgeY:Number = 0; [Inspectable(defaultValue=false)] public var useMinMax:Boolean = false; [Inspectable(defaultValue=0)] public var xMin:Number = 0; [Inspectable(defaultValue=0)] public var xMax:Number = 0; [Inspectable(defaultValue=0)] public var yMin:Number = 0; [Inspectable(defaultValue=0)] public var yMax:Number = 0; [Inspectable(defaultValue=false)] public var scrolling:Boolean = false; public var focus:DisplayObject = null; /// Object the viewport should center on. public var localPos:Point = null; /// Point within focus to center on. public var pos:Point = new Point(0, 0); /// Position within viewport that should be centered on the stage. public var rot:Number = 0; /// Rotation of the viewport. /// Variables to handle simple focus-change tweens. public var tFunc:Function; /// The tween function. public var tFrames:int; /// Amount of frames that have passed. public var tFramesTot:int; /// Total frames for the tween. public var tPos:Point; /// Starting position for the tween. public var tRot:Number; /// Starting rotation for the tween. public var tMX:Number; /// Starting mouseNudgeX for the tween. public var tMY:Number; /// Starting MouseNudgeY for the tween. public override function create():void { if(!focus && focusOn != '') { focus = Util.getDisplayObjectByPath(this, focusOn); } pos = globalToLocal(new Point(stage.stageWidth / 2, stage.stageHeight / 2)); rot = rotation; super.create(); if(scrolling) { listenWhileVisible(stage, Event.ENTER_FRAME, updateScroll, false, -9999); } } /** * Reorient so that the focus object or position is in the center of the stage. */ public function updateScroll(e:Event = null):void { /// If we have a focus object, then find the new position of the focus object in the viewport. if(focus) { pos = Util.localizePoint(this, focus, localPos); } var p:Point = pos.clone(); rot = scrollRotation(); var r:Number = rot; /// If mid-focus-change, tween from the old position & rotation to the new one. if(tFunc != null) { if(++tFrames == tFramesTot) { tFunc = null; } else { r = tFunc(tFrames, tRot, Util.findBetterAngleTarget(tRot, r) - tRot, tFramesTot); p.x = tFunc(tFrames, tPos.x, p.x - tPos.x, tFramesTot); p.y = tFunc(tFrames, tPos.y, p.y - tPos.y, tFramesTot); } } /// Set the position and rotation of the viewport. rotation = r; x = 0; y = 0; p = localToGlobal(p); x = stage.stageWidth / 2 - p.x; y = stage.stageHeight / 2 - p.y; if (useMinMax) { if (this.x < xMin) this.x = xMin; if (this.x > xMax) this.x = xMax; if (this.y < yMin) this.y = yMin; if (this.y > yMax) this.y = yMax; } /// Nudge the viewport based on the mouse. if(Input.mouseDetected) { x += (stage.stageWidth / 2 - Input.mousePos.x) * (tFunc != null ? tFunc(tFrames, tMX, mouseNudgeX - tMX, tFramesTot) : mouseNudgeX); y += (stage.stageHeight / 2 - Input.mousePos.y) * (tFunc != null ? tFunc(tFrames, tMY, mouseNudgeY - tMY, tFramesTot) : mouseNudgeY); } //x = Math.round(x); //y = Math.round(y); if(shake) { x += shake.x; y += shake.y; shake.normalize(shake.length * -0.5); if(shake.length < 1) { shake = null; } } } public var shake:Point; /** * Return how the scroller should be rotated. */ public function scrollRotation():Number { return rot; } /** * Indicate that the focus is changing. Call this before updating pos, rot, or focus to tween to the new view. */ public function startFocusTween(frames:uint = 30, func:Function = null):void { if(func == null) { func = Util.linearEase; } if(tFunc != null) { tRot = tFunc(tFrames, tRot, Util.findBetterAngleTarget(tRot, rot) - tRot, tFramesTot); var px:Number = tFunc(tFrames, tPos.x, pos.x - tPos.x, tFramesTot); var py:Number = tFunc(tFrames, tPos.y, pos.y - tPos.y, tFramesTot); tPos = new Point(px, py); tMX = tFunc(tFrames, tMX, mouseNudgeX - tMX, tFramesTot); tMY = tFunc(tFrames, tMY, mouseNudgeY - tMY, tFramesTot) } else { tPos = pos.clone(); tRot = rot; tMX = mouseNudgeX; tMY = mouseNudgeY; } tFramesTot = frames; tFrames = 0; tFunc = func; } }} |
There was a problem hiding this comment.
This (trivial code) is new:
[Inspectable(defaultValue=false)]
public var useMinMax:Boolean = false;
[Inspectable(defaultValue=0)]
public var xMin:Number = 0;
[Inspectable(defaultValue=0)]
public var xMax:Number = 0;
[Inspectable(defaultValue=0)]
public var yMin:Number = 0;
[Inspectable(defaultValue=0)]
public var yMax:Number = 0;
[...]
if (useMinMax)
{
if (this.x < xMin)
this.x = xMin;
if (this.x > xMax)
this.x = xMax;
if (this.y < yMin)
this.y = yMin;
if (this.y > yMax)
this.y = yMax;
}
|
This is definitely a useful feature. I also think it should be pulled into the mainline. |
|
Good feature, implemented it straight away. :) Thanx |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In many scenarios (e.g. Jump 'n' Run games) it's important to set min and max values to the x,y coordinates of scrollers. This functionality is added now.