class Camera

package nb

extends Object › Object

@:directlyUsed

The camera class.

It is in charge of repositioning and rescaling its associated nb.Scene instance and all the objects that were added to the camera using the add(not addChild) function.

You usually shouldn't manipulate an nb.Scene's properties directly, do it using its associated camera instead.

Available since

0.1.0

.

Constructor

new(scene:Scene)

Creates an nb.Camera instance.

Allows an h2d.Scene but that's untested. It's only guaranteed to work with an nb.Scene.

The camera will become a children of the scene. It will use an nb.Scene's addOutside function.

Parameters:

scene

The scene associated to the camera.

Variables

@:value(null)anchor:Point = null

An anchor point used when zooming.

read onlybounds:Bounds

The area the camera can move to is limited by this.

@:value(DEFAULT)childrenScaleMode:ScaleMode = DEFAULT

How the camera should scale its managed objects.

@:value(null)read onlyobjToFollow:Object = null

The object that the camera is following.

@:value([])finalobjects:Array<ObjData> = []

Objects managed by the camera.

@:value(new Point())offset:Point = new Point()

What the associated scene's position coordinate should be right now.

@:value([])onMoveFs:Array<CamF> = []

These functions gets called everytime the camera moves the scene.

@:value([])onScaleFs:Array<CamF> = []

These functions gets called everytime the camera rescales the scene.

read onlyscene:Scene

The associated scene.

@:value(DEFAULT)viewScaleMode:ScaleMode = DEFAULT

How the camera should scale the scene.

@:value(1)read onlyzoom:Float = 1

Zoom value. 1 is 100%, 2 is 50%, 0.5 is 200%...

Methods

@:value({ autoRescale : true, autoReposition : true, persistent : false, pos : 0 })add(o:Object, pos:Int = 0, persistent:Bool = false, autoReposition:Bool = true, autoRescale:Bool = true):ObjData

Adds an object on the camera.

It adds the tag "OnCam" to it which means the object is managed by the camera.

Parameters:

o

An nb.Object to add to the camera.

pos

o will be added at this position.

persistent

If true, the object will be the children of to the next main camera on switch.

autoReposition

Whether the camera is allowed to reposition the object.

autoRescale

Whether the camera is allowed to rescale the object.

Returns:

An nb.Camera.ObjData containing the aforementioned informations.

@:value({ name : "_" })inlineaddOnMoveF(f:Float ‑> Void, name:String = "_"):Void

Stores a function that gets executed whenever the cam moves the associated scene.

@:value({ name : "_" })inlineaddOnScaleF(f:Float ‑> Void, name:String = "_"):Void

Stores a function that gets executed whenever the cam rescales the associated scene.

floor():Void

Uses Math.floor on the associated scene's coordinate.

@:value({ dy : 0, dx : 0 })follow(o:Object, dx:Float = 0, dy:Float = 0):Void

Makes the camera follow an h2d.Object.

getObjData(o:Object):ObjData

Gets the nb.Camera.ObjData associated with o.

move(x:Float, y:Float):Void

Makes the associated scene move.

moveTo(x:Float, y:Float):Void

Makes the associated scene move.

dynamiconWindowResize():Void

Called by the associated nb.Scene's onResize function.

@:value({ ignoreAnchor : false, now : false })planRescale(now:Bool = false, ignoreAnchor:Bool = false):Void

Plans a rescaling.

reAdd(o:Object, data:ObjData):Void

Same as the add function but uses saved nb.Camera.ObjData.

Used on camera switch.

Parameters:

o

An nb.Object to add to the camera.

data

o's associated nb.Camera.ObjData.

rot(v:Float):Void

Makes the associated scene rotate.

round():Void

Rounds the associated scene's coordinate.

setBounds(xMin:Float, xMax:Float, yMin:Float, yMax:Float):Void

The area the camera can move to is limited by these values. Sets bounds.

setRot(v:Float):Void

Sets the associated scene's rotation.

setSize(w:Float, h:Float):Void

Stretch's the associated scene.

@:value({ now : false })setZoom(zoom:Float, ?anchor:Point, now:Bool = false):Void

Set the camera zoom value

Parameters:

zoom

Zoom value. 1 is 100%, 2 is 200%, 0.5 is 50%...

anchor

If not null, the camera's anchor point will be set to this.

now

Whether the rescaling should happen immediately.

unfollow():Void

Makes the camera stop following.

update(dt:Float):Void

Updates it's associated scene's and managed objects' properties.

It is called every frame by its associated scene's mandatoryUpdate function, which happens at the end of the game loop.

Also called by some of this instance's functions when requested.

Parameters:

dt

Elapsed time in seconds.

@:value({ duration : 1, h : 0, w : 0 })zoomAtArea(x:Float, y:Float, w:Float = 0, h:Float = 0, ?twType:TweenType, duration:Int = 1):Void

Zoom at an area.

Parameters:

x

Area x position.

y

Area y position.

w

Area width.

h

Area height.

twType

If not null, the camera will tween to the area.

duration

Tween duration in seconds.

Inherited Variables

Defined by Object

@:value(true)autoTogglableVisibility:Bool = true

Whether visible can be auto-toggled by this instance.

@:value(true)doOnContentChangedOnAdd:Bool = true

Whether the onContentChanged function should get called in the onAdd function.

@:value({ w : 0, h : 0 })read onlysize:Size = { w : 0, h : 0 }

The size of the object. You shouldn't modify it directly, use the setSize function instead.

This size is independent of the size of the displayed content that you get from functions like getBounds().

By default, this value doesn't change and gets its behavior defined by a children class.

Defined by Object

private@:dox(show)allocated:Bool

A flag that indicates whether the object was allocated or not.

When adding children to allocated objects, onAdd is being called immediately, otherwise it's delayed until the whole tree is added to a currently active Scene.

@:value(1.)alpha:Float = 1.

The amount of transparency of the Object.

@:value(Alpha)blendMode:BlendMode = Alpha

The blending mode of the object.

If there is no Object.filter active, only applies to the current object (not inherited by children). Otherwise tells how the filter is blended with background.

filter:Filter

The post process filter for this object.

When set, Object.alpha value affects both filter and object transparency (use Drawable.color.a to set transparency only for the object).

name:String

The name of the object. Can be used to retrieve an object within a tree by using Object.getObjectByName.

read onlynumChildren:Int

How many immediate children this object has.

@:value(nextId++)finalobjId:Int = nextId++

read onlyparent:Object

The parent object in the scene tree.

private@:dox(show)parentContainer:Object

The parent container of this object. See Object.contentChanged for more details.

private@:dox(show)posChanged:Bool

A flag that indicates that the object transform was modified and absolute position recalculation is required.

Automatically cleared on Object.sync and can be manually synced with the Object.syncPos.

@:value(0)rotation:Float = 0

The rotation angle of this object, in radians.

@:value(1)scaleX:Float = 1

The amount of horizontal scaling of this object.

@:value(1)scaleY:Float = 1

The amount of vertical scaling of this object.

@:value([])read onlytags:Array<{name:String, inherited:Bool, inheritable:Bool}> = []

@:value(true)visible:Bool = true

Is the object and its children are displayed on screen.

@:value(0)x:Float = 0

The x position (in pixels) of the object relative to its parent.

@:value(0)y:Float = 0

The y position (in pixels) of the object relative to its parent.

Inherited Methods

Defined by Object

addChildAt(s:Object, pos:Int):Void

Inserts a child object at the specified position of the children list.

private@:dox(show)contentChanged(o:Object):Void

Called by the children of a container object if they have parentContainer defined in them.

dynamiconParentResize():Void

Called when a parent object gets resized.

outsideScene():Bool

Checks whether this object's content can be seen.

searchByClass<T>(type:Class<T>):Array<T>

Returns an array of all children of the given type.

searchByName(regex:EReg):Array<Object>

Returns an array of h2d.Objects which name matches the regex.

Defined by Object

private@:dox(show)addBounds(relativeTo:Object, out:Bounds, dx:Float, dy:Float, width:Float, height:Float):Void

Adds specified area in local coordinate space to the bounds. Expected to be used within Object.getBoundsRec.

Parameters:

relativeTo

An object relative to which the Object bounds coordinates should be. If not set, coordinates are in absolute coordinate space.

out

An output Bounds instance.

dx

The top-left X offset of the added bounds rectangle.

dy

The top-left Y offset of the added bounds rectangle.

width

The width of the added bounds rectangle.

height

The height of the added bounds rectangle.

addChild(s:Object):Void

Add a child object at the end of the children list.

@:value({ inherited : false, inheritable : false })addTag(tagName:String, inheritable:Bool = false, inherited:Bool = false):Void

private@:dox(show)calcAbsPos():Void

Internal usage Calculates the absolute object position transform. See `Object.syncPos` for a safe position sync method. This method does not ensure that object parents also have up-to-date transform nor does it clear the `Object.posChanged` flag.

private@:value({ scaleY : 1., scaleX : 1. })@:dox(show)clipBounds(ctx:RenderContext, bounds:Bounds, scaleX:Float = 1., scaleY:Float = 1.):Void

Internal usage Clip the local bounds with our global viewport. Used during filter rendering in order to clip out areas that are off-screen and should not be rendered.

h2d.Scene note: clipBounds will always output bounds equivalent to entire window. This is done in order for scene to never clip out cameras as they may render virtually any area of the Scene.

private@:dox(show)constraintSize(maxWidth:Float, maxHeight:Float):Void

Advanced usage This can be called by a parent container to constraint the size of its children. Negative value mean that constraint is to be disabled.

For example, Text constraints it's maximum width, causing word-wrap to occur within constrained area.

See also:

  • FlowProperties.constraint

contains(o:Object):Bool

Tells if the object is contained into this object children, recursively.

private@:dox(show)draw(ctx:RenderContext):Void

Override this method in order to add custom graphics rendering to your Object. draw is invoked before rendering of the object children.

drawTo(t:Texture):Void

Draw the object and all its children into the given Texture.

drawToTextures(texs:Array<Texture>, outputs:Array<Output>):Void

Draw the object and all its children into the given Textures.

private@:dox(show)emitTile(ctx:RenderContext, tile:Tile):Void

Draws single Tile instance with this Object transform.

fOnChildren(?fAll:Object ‑> Void, ?fNb:Object ‑> Void):Void

find<T>(f:Object ‑> Null<T>):Null<T>

Find a single object in the tree by calling f on each and returning the first not-null value returned, or null if not found.

findAll<T>(f:Object ‑> Null<T>, ?arr:Array<T>):Array<T>

Find several objects in the tree by calling f on each and returning all the not-null values returned.

Parameters:

arr

An optional array instance to fill results with. Allocates a new array if not set.

getAbsPos():Matrix

Returns the updated absolute position matrix. See Object.getMatrix for current matrix values.

getBounds(?relativeTo:Object, ?out:Bounds):Bounds

Return the bounds of the object for its whole content, recursively.

Parameters:

relativeTo

An optional object relative to coordinates of which bounds are returned. Returns bounds in the absolute coordinates if not set.

out

An optional bounds instance to fill. Allocates new Bounds instance and returns it if not set.

private@:dox(show)getBoundsRec(relativeTo:Object, out:Bounds, forSize:Bool):Void

Override this method in order to expand the reported bounds of an object. Object.addBounds can be used to add bounds with respect to relativeTo. Do not remove the super call.

Parameters:

relativeTo

An object relative to which the Object bounds coordinates should be.

out

An output Bounds instance.

forSize

Whether it's being called for Object.getSize or Object.getBounds.

getChildAt(n:Int):Object

Return the nth element among the immediate children list of this object, or null if there is no Object at this position.

getChildIndex(o:Object):Int

Return the index of the object o within the immediate children list of this object, or -1 if it is not part of the children list.

private@:dox(show)getMatrix(m:Matrix):Void

Populates Matrix with current absolute object transform values. See Object.getAbsPos for up-to-date values.

getObjectByName(name:String):Object

Search for an object recursively by name, return null if not found.

getObjectsCount():Int

Return the total number of children in the whole tree, recursively.

getScene():Scene

Returns an h2d.Scene down the hierarchy tree or null if object is not added to Scene.

finalgetSize(?out:Bounds):Bounds

Similar to getBounds(parent), but instead of the full content, it will return the size based on the alignment of the object. For instance for a text, Object.getBounds will return the full glyphs size whereas getSize will ignore the pixels under the baseline.

Parameters:

out

An optional bounds instance to fill. Allocates new Bounds instance and returns it if not set.

globalToLocal(pt:Point):Point

Convert an absolute screen position into a local position relative to the object origin, applying all the inherited transforms.

Parameters:

pt

A position to convert and return. Modifies the Point instance as is.

hasTag(tagName:String):Bool

inlineiterator():ArrayIterator_h2d_Object

Return an iterator over this object immediate children

localToGlobal(?pt:Point):Point

Convert a local position (or [0,0] if pt is null) relative to the object origin into an absolute screen position, applying all the inherited transforms.

Parameters:

pt

An optional position to convert and return. Allocates new Point at 0,0 position if not set. Modifies the Point instance as is.

private@:dox(show)onAdd():Void

Sent when object is being added to an allocated scene.

Do not remove the super call when overriding.

private@:dox(show)inlineonContentChanged():Void

Should be called when Object content was changed in order to notify parent container. See Object.contentChanged.

private@:dox(show)onHierarchyMoved(parentChanged:Bool):Void

Sent when object was already allocated and moved within scene object tree hierarchy.

Do not remove the super call when overriding.

Parameters:

parentChanged

Whether Object was moved withing same parent (through Layers.ysort for example) or relocated to a new one.

private@:dox(show)onRemove():Void

Sent when object is removed from the allocated scene.

Do not remove the super call when overriding.

inlineremove():Void

Same as parent.removeChild(this), but does nothing if parent is null.

removeChild(s:Object):Void

Remove the given object from the immediate children list of the object if it's part of it.

removeChildren():Void

Remove all children from the immediate children list.

removeTag(tagName:String):Void

inlinerotate(v:Float):Void

Rotate the object by the given angle (in radians)

inlinescale(v:Float):Void

Scale uniformly the object by the given factor.

private@:dox(show)setParentContainer(c:Object):Void

Sets the parent container for this Object and it's children. See Object.contentChanged for more details.

inlinesetPosition(x:Float, y:Float):Void

Set the position of the object relative to its parent.

inlinesetScale(v:Float):Void

Set the uniform scale for the object.

private@:dox(show)sync(ctx:RenderContext):Void

Performs a sync of data for rendering (such as absolute position recalculation). While this method can be used as a substitute to an update loop, it's primary purpose it to prepare the Object to be rendered.

Do not remove the super call when overriding.

private@:dox(show)syncPos():Void

Ensures that object has an up-to-date position transform.