Package | away3d.primitives |
Class | public class Sphere |
Inheritance | Sphere ![]() ![]() ![]() ![]() ![]() ![]() |
Property | Defined by | ||
---|---|---|---|
![]() | animation : AnimationBase
The type of animation used to influence the geometry.
| Mesh | |
![]() | animationController : AnimatorBase
The animation controller that will update the mesh's animation state.
| Mesh | |
![]() | animationState : AnimationStateBase
The animation state of the mesh, defining how the animation should influence the mesh's geometry.
| Mesh | |
![]() | bounds : BoundingVolumeBase
The bounding volume approximating the volume occupied by the Entity.
| PrimitiveBase | |
![]() | castsShadows : Boolean
Indicates whether or not the Mesh can cast shadows
| Mesh | |
![]() | eulers : Vector3D
Defines the rotation of the 3d object as a
Vector3D object containing euler angles for rotation around x, y and z axis. | Object3D | |
![]() | extra : Object
An object that can contain any extra data.
| Object3D | |
![]() | geometry : Geometry
The geometry used by the mesh that provides it with its shape.
| PrimitiveBase | |
![]() | inverseSceneTransform : Matrix3D
The inverse scene transform object that transforms from world to model space.
| ObjectContainer3D | |
![]() | material : MaterialBase
The material with which to render the Mesh.
| Mesh | |
![]() | maxX : Number
The maximum extremum of the object along the X-axis.
| Entity | |
![]() | maxY : Number
The maximum extremum of the object along the Y-axis.
| Entity | |
![]() | maxZ : Number
The maximum extremum of the object along the Z-axis.
| Entity | |
![]() | minX : Number
The minimum extremum of the object along the X-axis.
| Entity | |
![]() | minY : Number
The minimum extremum of the object along the Y-axis.
| Entity | |
![]() | minZ : Number
The minimum extremum of the object along the Z-axis.
| Entity | |
![]() | modelViewProjection : Matrix3D
The current model-view-projection (MVP) matrix - the one on the top of the stack - used to transform from
model to homogeneous projection space.
| Entity | |
![]() | mouseDetails : Boolean
Indicates whether or not mouse events contain UV and position coordinates.
| Mesh | |
![]() | mouseEnabled : Boolean
Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.
| Entity | |
![]() | name : String
The name of the object.
| Object3D | |
![]() | numChildren : uint
The amount of child objects of the ObjectContainer3D.
| ObjectContainer3D | |
![]() | parent : ObjectContainer3D
The parent ObjectContainer3D to which this object's transformation is relative.
| ObjectContainer3D | |
![]() | partition : Partition3D
The space partition to be used by the object container and all its recursive children, unless it has its own
space partition assigned.
| ObjectContainer3D | |
![]() | pivotPoint : Vector3D
Defines the local point around which the object rotates.
| Object3D | |
![]() | position : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
radius : Number
The radius of the sphere.
| Sphere | ||
![]() | rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | scaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates.
| Object3D | |
![]() | scaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates.
| Object3D | |
![]() | scaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates.
| Object3D | |
![]() | scenePosition : Vector3D
The global position of the ObjectContainer3D in the scene.
| ObjectContainer3D | |
![]() | sceneTransform : Matrix3D
The transformation matrix that transforms from model to world space.
| ObjectContainer3D | |
segmentsH : uint
Defines the number of vertical segments that make up the sphere.
| Sphere | ||
segmentsW : uint
Defines the number of horizontal segments that make up the sphere.
| Sphere | ||
![]() | subMeshes : Vector
The SubMeshes out of which the Mesh consists.
| PrimitiveBase | |
![]() | transform : Matrix3D
The local transformation matrix that transforms to the parent object's space.
| ObjectContainer3D | |
![]() | x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
yUp : Boolean
Defines whether the sphere poles should lay on the Y-axis (true) or on the Z-axis (false).
| Sphere | ||
![]() | z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | zIndex : Number
The distance of the IRenderable object to the view, used to sort per object.
| Entity |
Method | Defined by | ||
---|---|---|---|
Sphere
(material:MaterialBase = null, radius:Number = 50, segmentsW:uint = 16, segmentsH:uint = 12, yUp:Boolean = true)
Creates a new Sphere object.
| Sphere | ||
![]() |
Adds a child ObjectContainer3D to the current object.
| ObjectContainer3D | |
![]() |
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
| ObjectContainer3D | |
![]() |
| PrimitiveBase | |
![]() |
dispose(deep:Boolean):void
Cleans up any resources used by the current object.
| Mesh | |
![]() |
Retrieves the child object at the given index.
| ObjectContainer3D | |
![]() |
Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance
| Entity | |
![]() |
lookAt(target:Vector3D, upAxis:Vector3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent
ObjectContainer3D . | ObjectContainer3D | |
![]() |
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
| Object3D | |
![]() |
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
| Object3D | |
![]() |
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
| Object3D | |
![]() |
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
| Object3D | |
![]() |
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates.
| Object3D | |
![]() |
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
| Object3D | |
![]() |
moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
| Object3D | |
![]() |
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
| Object3D | |
![]() |
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
| Object3D | |
![]() |
popModelViewProjection():void
Removes a model view projection matrix from the stack, used when leaving a render.
| Entity | |
![]() |
Updates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space
and places it on the stack.
| Entity | |
![]() |
Removes a 3d object from the child array of the container
| ObjectContainer3D | |
![]() |
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
![]() |
rotate(axis:Vector3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
| Object3D | |
![]() |
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
| Object3D | |
![]() |
scale(value:Number):void
Appends a uniform scale to the current transformation.
| Object3D | |
![]() |
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | |
![]() |
translateLocal(axis:Vector3D, distance:Number):void
| ObjectContainer3D | |
![]() |
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
Method | Defined by | ||
---|---|---|---|
Builds the primitive's geometry when invalid.
| Sphere | ||
Builds the primitive's uv coordinates when invalid.
| Sphere | ||
![]() |
Factory method that returns the current partition node.
| Mesh | |
![]() |
Creates the default bounding box to be used by this type of Entity.
| Entity | |
![]() |
initGeometry():void
Initialises the SubMesh objects to map unto the Geometry's SubGeometry objects.
| Mesh | |
![]() |
invalidateBounds():void
Invalidates the bounding volume, causing to be updated when requested.
| Entity | |
![]() |
invalidateGeometry():void
Invalidates the primitive's geometry, causing it to be updated when requested.
| PrimitiveBase | |
![]() |
invalidateSceneTransform():void
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
| Entity | |
![]() |
invalidateTransform():void
Invalidates the transformation matrix, causing it to be updated upon the next request
| ObjectContainer3D | |
![]() |
invalidateUVs():void
Invalidates the primitive's uv coordinates, causing them to be updated when requested.
| PrimitiveBase | |
![]() |
updateBounds():void
Updates the bounding volume for the object.
| Mesh | |
![]() |
updateSceneTransform():void
Updates the scene transformation matrix.
| ObjectContainer3D | |
![]() |
updateTransform():void
| Object3D |
radius | property |
radius:Number
[read-write]The radius of the sphere.
Implementation public function get radius():Number
public function set radius(value:Number):void
segmentsH | property |
segmentsH:uint
[read-write]Defines the number of vertical segments that make up the sphere. Defaults to 12.
Implementation public function get segmentsH():uint
public function set segmentsH(value:uint):void
segmentsW | property |
segmentsW:uint
[read-write]Defines the number of horizontal segments that make up the sphere. Defaults to 16.
Implementation public function get segmentsW():uint
public function set segmentsW(value:uint):void
yUp | property |
yUp:Boolean
[read-write]Defines whether the sphere poles should lay on the Y-axis (true) or on the Z-axis (false).
Implementation public function get yUp():Boolean
public function set yUp(value:Boolean):void
Sphere | () | constructor |
public function Sphere(material:MaterialBase = null, radius:Number = 50, segmentsW:uint = 16, segmentsH:uint = 12, yUp:Boolean = true)
Parameters
material:MaterialBase (default = null ) — The material with which to render the sphere.
|
|
radius:Number (default = 50 ) — The radius of the sphere.
|
|
segmentsW:uint (default = 16 ) — Defines the number of horizontal segments that make up the sphere. Defaults to 16.
|
|
segmentsH:uint (default = 12 ) — Defines the number of vertical segments that make up the sphere. Defaults to 12.
|
|
yUp:Boolean (default = true ) — Defines whether the sphere poles should lay on the Y-axis (true) or on the Z-axis (false).
|
buildGeometry | () | method |
protected override function buildGeometry(target:SubGeometry):void
Builds the primitive's geometry when invalid. This method should not be called directly. The calling should be triggered by the invalidateGeometry method (and in turn by updateGeometry).
Parameterstarget:SubGeometry |
buildUVs | () | method |
protected override function buildUVs(target:SubGeometry):void
Builds the primitive's uv coordinates when invalid. This method should not be called directly. The calling should be triggered by the invalidateUVs method (and in turn by updateUVs).
Parameterstarget:SubGeometry |