Class CAAT.Foundation.UI.PathActor

Extends CAAT.Foundation.Actor.

Defined in: PathActor.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	CAAT.Foundation.UI.PathActor()

Field Summary
Field Attributes	Field Name and Description
	bOutline draw the bounding rectangle too ?
	interactive Set this path as interactive.
	onUpdateCallback If the path is interactive, some handlers are shown to modify the path.
	outlineColor Outline the path in this color.
	path Path to draw.
	pathBoundingRectangle Calculated path´s bounding box.

Fields borrowed from class CAAT.Foundation.Actor:: __super, AABB, alpha, backgroundImage, behaviorList, cached, clip, clipPath, dirty, discardable, duration, expired, fillStyle, frameAlpha, gestureEnabled, glEnabled, height, id, inFrame, invalid, isAA, isCachedActor, isGlobalAlpha, lifecycleListenerList, minimumSize, modelViewMatrix, modelViewMatrixI, mouseEnabled, oldX, oldY, parent, pointed, preferredSize, preventLayout, rotationAngle, rotationX, rotationY, scaleAnchor, scaleTX, scaleTY, scaleX, scaleY, size_active, size_total, start_time, strokeStyle, tAnchorX, tAnchorY, time, viewVertices, visible, wdirty, width, worldModelViewMatrix, worldModelViewMatrixI, x, y

Method Summary
Method Attributes	Method Name and Description
	getPath() Return the contained path.
	mouseDown(mouseEvent) Route mouse down functionality to the contained path.
	mouseDrag(mouseEvent) Route mouse dragging functionality to the contained path.
	mouseUp(mouseEvent) Route mouse up functionality to the contained path.
	paint(director, time) Paint this actor.
	setInteractive(interactive) Set the contained path as interactive.
	setOnUpdateCallback(fn)
	setPath(path) Sets the path to manage.
	showBoundingBox(show, color) Enables/disables drawing of the contained path's bounding box.

Methods borrowed from class CAAT.Foundation.Actor:: __init, __paintActor, __scale1To, __validateLayout, addAnimation, addBehavior, addListener, animate, cacheAsBitmap, centerAt, centerOn, clean, contains, create, destroy, disableDrag, drawScreenBoundingBox, emptyBehaviorList, enableDrag, enableEvents, endAnimate, findActorAtPosition, findActorById, fireEvent, gestureChange, gestureEnd, gestureStart, getAnchor, getAnchorPercent, getBehavior, getId, getMinimumSize, getPreferredSize, getTextureGLPage, glNeedsFlush, glSetShader, initialize, invalidate, invalidateLayout, isCached, isGestureEnabled, isInAnimationFrame, isVisible, modelToModel, modelToView, mouseClick, mouseDblClick, mouseEnter, mouseExit, mouseMove, mouseOut, mouseOver, moveTo, paintActor, paintActorGL, playAnimation, removeBehaviorById, removeBehaviour, removeListener, resetAnimationTime, resetAsButton, resetTransform, rotateTo, scaleTo, scaleXTo, scaleYTo, setAlpha, setAnimationEndCallback, setAnimationImageIndex, setAsButton, setBackgroundImage, setBackgroundImageOffset, setBounds, setButtonImageIndex, setCachedActor, setChangeFPS, setClip, setDiscardable, setExpired, setFillStyle, setFrameTime, setGestureEnabled, setGLCoords, setGlobalAlpha, setGlobalAnchor, setId, setImageTransformation, setLocation, setMinimumSize, setModelViewMatrix, setOutOfFrameTime, setPaint, setParent, setPosition, setPositionAnchor, setPositionAnchored, setPreferredSize, setPreventLayout, setRotation, setRotationAnchor, setRotationAnchored, setScale, setScaleAnchor, setScaleAnchored, setScreenBounds, setSize, setSpriteIndex, setStrokeStyle, setUV, setVisible, stopCacheAsBitmap, touchEnd, touchMove, touchStart, viewToModel

Class Detail

CAAT.Foundation.UI.PathActor()

Field Detail

bOutline

draw the bounding rectangle too ?

interactive

Set this path as interactive.

onUpdateCallback

If the path is interactive, some handlers are shown to modify the path. This callback function will be called when the path is interactively changed.

outlineColor

Outline the path in this color.

path

Path to draw.

pathBoundingRectangle

Calculated path´s bounding box.

Method Detail

{CAAT.Path} getPath()

Return the contained path.

Returns:: {CAAT.Path}

mouseDown(mouseEvent)

Route mouse down functionality to the contained path.

Parameters:
mouseEvent: {CAAT.Event.MouseEvent}

mouseDrag(mouseEvent)

Route mouse dragging functionality to the contained path.

Parameters:
mouseEvent: {CAAT.Event.MouseEvent}

mouseUp(mouseEvent)

Route mouse up functionality to the contained path.

Parameters:
mouseEvent: {CAAT.Event.MouseEvent}

paint(director, time)

Paint this actor.

Parameters:
director: {CAAT.Foundation.Director}
time: {number}. Scene time.

setInteractive(interactive)

Set the contained path as interactive. This means it can be changed on the fly by manipulation of its control points.

Parameters:
interactive

setOnUpdateCallback(fn)

Parameters:
fn

setPath(path)

Sets the path to manage.

Parameters:
path: {CAAT.PathUtil.PathSegment}

Returns:: this

showBoundingBox(show, color)

Enables/disables drawing of the contained path's bounding box.

Parameters:
show: {boolean} whether to show the bounding box
color: {=string} optional parameter defining the path's bounding box stroke style.

Classes

Class CAAT.Foundation.UI.PathActor