flare.core.Shape3D

Public Properties

	Property		Defined By
		animationEnabled : Boolean = true Activates or deactivates the animation.	Pivot3D
		animationMode : int = 0	Pivot3D
		children : Vector.<Pivot3D> [read-only] Returns a Pivot3D-type vector with its children.	Pivot3D
		components : Vector.<IComponent> A collection vector that contains all the components of the object.	Pivot3D
		currentFrame : Number Returns or sets the frame number where the pivot is situated.	Pivot3D
		dirty : Boolean = true Gets or sets when the object has changed his transform matrix by hand.	Pivot3D
		frames : Vector.<Frame3D> Vector that contains all the animation frames.	Pivot3D
		frameSpeed : Number Returns or sets animation speed.	Pivot3D
		global : Matrix3D Returns a matrix with the global position, rotation and scale of the object.	Pivot3D
		invGlobal : Matrix3D [read-only] Returns a matrix with the inverse global position, rotation and scale of the object.	Pivot3D
		inView : Boolean [read-only]	Pivot3D
		isPlaying : Boolean [read-only] Returns true if an animation is being played.	Pivot3D
		labels : Array Returns or sets a vector that contains the Labels3D objects used to play and manage animations.	Pivot3D
		layer : int = 0 Gets or sets the layer to render the object.	Pivot3D
		name : String Sets or returns the object name.	Pivot3D
		parent : Pivot3D Returns or sets the object’s parent.	Pivot3D
		priority : int = 0 This value is for internal use to calculate the priority acording the distance from the camera during the render.	Pivot3D
		scaleX : Number Increases or decreases the object scale on the X axis from its current scale.	Pivot3D
		scaleY : Number Increases or decreases the object scale on the Y axis from its current scale.	Pivot3D
		scaleZ : Number Increases or decreases the object scale on the Z axis from its current scale.	Pivot3D
		scene : Scene3D [read-only] Gets a reference to the scene that contains the object.	Pivot3D
		sortMode : int Gets ot sets the sorting mode for the object.	Pivot3D
		splines : Vector.<Spline3D> Spline3D-type vector with the splines contained in the Shape3D.	Shape3D
		updatable : Boolean	Pivot3D
		userData : Object Sets or returns an object for free use by the user.	Pivot3D
		visible : Boolean Sets or returns whether the object is visible.	Pivot3D
		world : Matrix3D Sets or returns the matrix of local position, rotation and scale.	Pivot3D
		x : Number Returns or sets the position on the X axis.	Pivot3D
		y : Number Returns or sets the position on the Y axis.	Pivot3D
		z : Number Returns or sets the position on the Z axis.	Pivot3D

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Shape3D(name:String) Creates a new set of splines.	Shape3D
		addChild(pivot:Pivot3D, useGlobalSpace:Boolean = false):Pivot3D Add a new object as a child.	Pivot3D
		addComponent(component:IComponent):Boolean Adds a new component to the object.	Pivot3D
		addLabel(label:Label3D, includeChildren:Boolean = true):Label3D Adds a label that refers to a given animation.	Pivot3D
		clone():Pivot3D Creates a copy of the object and all its elements.	Pivot3D
		copyTransformFrom(source:Pivot3D, local:Boolean = true):void Copies all transformations (position, rotation and scale) from another Pivot3D object.	Pivot3D
		download():void	Pivot3D
		draw(includeChildren:Boolean = true):void Draws the object.	Pivot3D
		forEach(callback:Function, filterClass:Class = null, params:Object = null, includeChildren:Boolean = true):void Excecutes a calback functions for each of his children.	Pivot3D
		getBackward(local:Boolean = true, out:Vector3D = null):Vector3D Returns the direction vector that points to the back of the object.	Pivot3D
		getChildByName(name:String, startIndex:int = 0, includeChildren:Boolean = true):Pivot3D Returns the first child that matches the specified name.	Pivot3D
		getDir(local:Boolean = true, out:Vector3D = null):Vector3D Returns the direction vector that points to the front of the object.	Pivot3D
		getDown(local:Boolean = true, out:Vector3D = null):Vector3D Returns the direction vector that points to the bottom side of the object.	Pivot3D
		getLeft(local:Boolean = true, out:Vector3D = null):Vector3D Returns the direction vector that points to the left side of the object.	Pivot3D
		getMaterialByName(name:String, includeChildren:Boolean = true):Material3D Returns the first material that matches the specified name.	Pivot3D
		getPoint(value:Number, global:Boolean = true, out:Vector3D = null):Vector3D Returns the position on the spline depending on the “value” parameter.	Shape3D
		getPosition(local:Boolean = true, out:Vector3D = null):Vector3D Returns the current position of the object.	Pivot3D
		getRight(local:Boolean = true, out:Vector3D = null):Vector3D Returns the direction vector that points to the right side of the object.	Pivot3D
		getRotation(local:Boolean = true, out:Vector3D = null):Vector3D Returns the current rotation of the object in euler angles.	Pivot3D
		getScale(local:Boolean = true, out:Vector3D = null):Vector3D Returns the current scale of the object.	Pivot3D
		getScreenCoords(out:Vector3D = null, camera:Camera3D = null, viewPort:Rectangle = null):Vector3D Returns the coordinates of an object with respect to the screen.	Pivot3D
		getTangent(value:Number, global:Boolean = true, out:Vector3D = null):Vector3D Returns the direction on the spline in a given position.	Shape3D
		getUp(local:Boolean = true, out:Vector3D = null):Vector3D Returns the direction vector that points to the upper side of the object.	Pivot3D
		globalToLocal(point:Vector3D, out:Vector3D = null):Vector3D Transforms a point of the global space of the object into a local space.	Pivot3D
		globalToLocalVector(vector:Vector3D, out:Vector3D = null):Vector3D Transforms a point of the global space of the object into a local space without translation.	Pivot3D
		gotoAndPlay(frame:Object, blendFrames:Number = 0, animationMode:int):void	Pivot3D
		gotoAndStop(frame:Object, blendFrames:Number = 0):void Stops the animation at the specified frame.	Pivot3D
		hide():void Sets whether the object is visible.	Pivot3D
		localToGlobal(point:Vector3D, out:Vector3D = null):Vector3D Transforms a point of the local space into the global space.	Pivot3D
		localToGlobalVector(vector:Vector3D, out:Vector3D = null):Vector3D Transforms a point of the local space of the object into a global space without translation.	Pivot3D
		lookAt(x:Number, y:Number, z:Number, up:Vector3D = null, smooth:Number = 1):void Directs the object towards the specified position.	Pivot3D
		nextFrame():void	Pivot3D
		play(animationMode:int = 0):void	Pivot3D
		prevFrame():void	Pivot3D
		removeChild(pivot:Pivot3D):Pivot3D Removes a child of the object.	Pivot3D
		removeComponent(component:IComponent):Boolean Removes a component from the object.	Pivot3D
		removeLabel(label:Label3D, includeChildren:Boolean = true):Label3D Removes a label.	Pivot3D
		replaceMaterial(source:Material3D, replaceFor:Material3D, includeChildren:Boolean = true):void Replaces an existing material of the object with another material.	Pivot3D
		resetTransforms():void Resets the object position, rotation and scale.	Pivot3D
		rotateAxis(angle:Number, axis:Vector3D, pivotPoint:Vector3D = null):void Rotates the object on the specified axis from its current position.	Pivot3D
		rotateX(angle:Number, local:Boolean = true, pivotPoint:Vector3D = null):void Rotates the object on the X axis from its current position.	Pivot3D
		rotateY(angle:Number, local:Boolean = true, pivotPoint:Vector3D = null):void Rotates the object on the Y axis from its current position.	Pivot3D
		rotateZ(angle:Number, local:Boolean = true, pivotPoint:Vector3D = null):void Rotates the pivot on the Z axis from its current position.	Pivot3D
		setLayer(value:int, includeChildren:Boolean = true):void Sets the layer to render the object and all of his children.	Pivot3D
		setMaterial(material:Material3D, includeChildren:Boolean = true):void Sets a material for the object and, optionally, all its descendants.	Pivot3D
		setNormalOrientation(normal:Vector3D, smooth:Number = 1):void Aligns the object to a normal.	Pivot3D
		setOrientation(dir:Vector3D, up:Vector3D = null, smooth:Number = 1):void Orients the object in a specific direction.	Pivot3D
		setPosition(x:Number, y:Number, z:Number, smooth:Number = 1, local:Boolean = true):void Sets the position of the object.	Pivot3D
		setRotation(x:Number, y:Number, z:Number):void Sets the object rotation using euler angles.	Pivot3D
		setScale(x:Number, y:Number, z:Number, smooth:Number = 1):void Sets the object scale.	Pivot3D
		setTranslation(x:Number = 0, y:Number = 0, z:Number = 0, local:Boolean = true):void Translates the object from its current position to the specified distance.	Pivot3D
		show():void Sets whether the object is visible.	Pivot3D
		startDrag(lockCenter:Boolean = false, reference:Vector3D = null):void Lets the user drag the specified Pivot3D.	Pivot3D
		stop():void	Pivot3D
		stopDrag():void Ends the startDrag() method.	Pivot3D
		translateAxis(distance:Number, axis:Vector3D):void Translates the object on a certain axis from its current position.	Pivot3D
		translateX(distance:Number, local:Boolean = true):void Translates the object on the X axis from its current position.	Pivot3D
		translateY(distance:Number, local:Boolean = true):void Translates the object on the Y axis from its current position.	Pivot3D
		translateZ(distance:Number, local:Boolean = true):void Translates the object on the Z axis from its current position.	Pivot3D
		update():void	Pivot3D
		updateTransforms(includeChildren:Boolean = false):void This method is used to force the system to update the object in those cases where its matrices have been modified manually.	Pivot3D
		upload(scene:Scene3D = null, force:Boolean = false, includeChildren:Boolean = true):Boolean	Pivot3D

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
added	This event occurs when the object is added to a scene or to any other object.	Pivot3D
addedToScene	This event occurs when the object is added to a scene.	Pivot3D
animationComplete	This event occurs at the end of an animation.	Pivot3D
changeTransform	This event occurs whatever the object changes his position, rotation or scale.	Pivot3D
enterDrag	This event occurs before drag the object.	Pivot3D
enterDraw	This event occurs before draw the object.	Pivot3D
enterFrame	This event occurs before entering any frame.	Pivot3D
exitDrag	This event occurs after drag the object.	Pivot3D
exitDraw	This event occurs after draw the object.	Pivot3D
exitFrame	This event occurs after updating every frame.	Pivot3D
removed	This event occurs when the object is removed from a scene or from any other object.	Pivot3D
removedFromScene	This event occurs when the object is removed from a scene.	Pivot3D
unload	This event occurs when the dispose method of the object itself or of a parent object is called.	Pivot3D

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ADDED_EVENT : String = added [static] Defines the value for the 'added' event.	Pivot3D
		ADDED_TO_SCENE_EVENT : String = addedToScene [static] Defines the value for the 'addedToScene' event.	Pivot3D
		ANIMATION_COMPLETE_EVENT : String = animationComplete [static] Defines the value for the 'animationComplete' event.	Pivot3D
		ANIMATION_LOOP_MODE : int = 0 [static]	Pivot3D
		ANIMATION_PING_PONG_MODE : int = 1 [static]	Pivot3D
		ANIMATION_STOP_MODE : int = 2 [static]	Pivot3D
		ENTER_DRAW_EVENT : String = enterDraw [static] Defines the value for the 'enterDraw' event.	Pivot3D
		ENTER_FRAME_EVENT : String = enterFrame [static] Defines the value for the 'enterFrame' event.	Pivot3D
		EXIT_DRAW_EVENT : String = exitDraw [static] Defines the value for the 'exitDraw' event.	Pivot3D
		EXIT_FRAME_EVENT : String = exitFrame [static] Defines the value for the 'exitFrame' event.	Pivot3D
		REMOVED_EVENT : String = removed [static] Defines the value for the 'removed' event.	Pivot3D
		REMOVED_FROM_SCENE_EVENT : String = removedFromScene [static] Defines the value for the 'removedFromScene' event.	Pivot3D
		SORT_CENTER : int = 1 [static]	Pivot3D
		SORT_FAR : int = 4 [static]	Pivot3D
		SORT_NEAR : int = 2 [static]	Pivot3D
		SORT_NONE : int = 0 [static]	Pivot3D
		UNLOAD_EVENT : String = unload [static] Defines the value for the 'unload' event.	Pivot3D
		UPDATE_TRANSFORM_EVENT : String = updateTransform [static] Defines the value for the 'updateTransform' event.	Pivot3D

Property Detail

splines

property

public var splines:Vector.<Spline3D>

Spline3D-type vector with the splines contained in the Shape3D.

Constructor Detail

Shape3D

()

Constructor

public function Shape3D(name:String)

Creates a new set of splines.

Parameters

name:String — Object name.

Method Detail

getPoint

()

method

public function getPoint(value:Number, global:Boolean = true, out:Vector3D = null):Vector3D

Returns the position on the spline depending on the “value” parameter. This method will take into consideration all the splines (Spline3D) that are contained in the Shape3D. For example, if two Spline3D objects are contained, a value ranging from 0.0 to 0.5 in the “value” parameter will locate the resulting position on the first spline, whereas a value ranging from 0.5 to 1.0 will locate the resulting position on the second spline.

Parameters

	`value:Number` — 0 to 1 value that represents the position in time on the spline.

	`global:Boolean` (default = `true`) — Sets whether the value will be returned in the global space or local space of the Shape3D. The default value is 'true'.

	`out:Vector3D` (default = `null`) — Vector where the position will be returned.

Returns

Vector3D — If an 'out' value has been specified, the same object is returned. Otherwise, a new vector with the position is returned.

getTangent

()

method

public function getTangent(value:Number, global:Boolean = true, out:Vector3D = null):Vector3D

Returns the direction on the spline in a given position. This method will take into consideration all the splines (Spline3D) that are contained in the Shape3D. For example, if two Spline3D objects are contained, a value ranging from 0.0 to 0.5 in the “value” parameter will locate the resulting position on the first spline, whereas a value ranging from 0.5 to 1.0 will locate the resulting position on the second spline.

Parameters

	`value:Number` — 0 to 1 value that represents the position in time on the spline.

	`global:Boolean` (default = `true`) — Sets whether the value will be returned in the global space or local space of the Shape3D. The default value is 'true'.

	`out:Vector3D` (default = `null`) — Vector where the direction will be returned.

Returns

Vector3D — If an 'out' value has been specified, the same object is returned. Otherwise, a new vector with the position is returned.

Flare3D	All Packages \| All Classes \| Index \| Frames No Frames
Shape3D	Properties \| Methods \| Events \| Constants

Package	flare.core
Class	public class Shape3D
Inheritance	Shape3D Pivot3D flash.events.EventDispatcher