sandy.primitive.Cylinder

Public Properties

	Property		Defined by
		aPolygons : Array The array of polygons building this object.	Shape3D
		appearance : Appearance The appearance of this object.	Shape3D
		boundingBox : BBox The bounding box of this node IMPORTANT: Do not modify it unless you perfectly know what you are doing	Node
		boundingSphere : BSphere The bounding sphere of this node IMPORTANT: Do not modify it unless you perfectly know what you are doing	Node
		broadcaster : BubbleEventBroadcaster The broadcaster The broadcaster is used to send events to listeners. This property is a BubbleEventBroadcaster.	Node
		changed : Boolean = false This property set the cache status of the current node.	Node
		container : Sprite The contianer for this object.	Shape3D
		culled : CullingState This property represent the culling state of the current node.	Node
		DEFAULT_APPEARANCE : Appearance [static] Default appearance for Shape3D instances.	Shape3D
		DEFAULT_MATERIAL : Material [static] Default material for the DEFAULT_APPEARANCE object	Shape3D
		depth : Number The depth of this object.	Shape3D
		depthSorter : IDepthSorter Apply a new depth sorter to all the polygons.	Shape3D
		disable : Boolean = false Disable the local transformations applied to this Node if set to false.	ATransformable
		enableBackFaceCulling : Boolean Should back face culling be enabled for this object?.	Shape3D
		enableClipping : Boolean = false Enable the Frustum clipping on the visible polygons.	Shape3D
		enableEvents : Boolean Enables the event system for mouse events.	Shape3D
		enableForcedDepth : Boolean = false Should forced depth be enable for this object?.	Shape3D
		enableInteractivity : Boolean Enable the interactivity on this shape and its polygon.	Shape3D
		enableNearClipping : Boolean = false Enable the Frustum near plane clipping on the visible polygons.	Shape3D
		forcedDepth : Number = 0 The forced depth for this object.	Shape3D
		geometry : Geometry3D The geometry of this object.	Shape3D
		geometryCenter : Vector This property call allows you to get the geometryCenter offset vector of the Shape.	Shape3D
		invModelMatrix : Matrix4 This property will remains null until a material needs it, defining the SandyFlag INVERT_MODEL_MATRIX In that case, that property will return the invert model matrix on that node	Shape3D
		matrix : Matrix4	ATransformable
		name : String Name of this node.	Node
		out : Vector Forward direction ( local z ) in parent coordinates.	ATransformable
		pan : Number Pans this object around the local y axis.	ATransformable
		parent : Node The parent node of this node.	Node
		roll : Number Rolls this object around the local z axis.	ATransformable
		rotateX : Number Rotates this object around an axis parallel to the parents x axis.	ATransformable
		rotateY : Number Rotates this object around an axis parallel to the parents y axis.	ATransformable
		rotateZ : Number Rotates this object around an axis paralell to the parents z axis.	ATransformable
		scaleX : Number x scale of this object.	ATransformable
		scaleY : Number y scale of this object.	ATransformable
		scaleZ : Number z scale of this object.	ATransformable
		scene : Scene3D = null Reference to the scene is it linked to.	Node
		segmentsH : Number The number of vertical segments.	Cylinder
		segmentsW : Number The number of horizontal segments.	Cylinder
		side : Vector Side direction ( local x ) in parent coordinates.	ATransformable
		target : Vector The position in the parent frame this object should "look at".	ATransformable
		tilt : Number Tilts this object around the local x axis.	ATransformable
		up : Vector Up direction ( local y ) in parent coordinates.	ATransformable
		useSingleContainer : Boolean setter that allow user to change the way to render this object.	Shape3D
		visible : Boolean = true Specify the visibility of this node.	Node
		visiblePolygonsCount : uint	Shape3D
		x : Number x position of this object in its parent frame.	ATransformable
		y : Number y position of this object in its parent frame.	ATransformable
		z : Number z position of the node in its parent frame.	ATransformable

	Property	Defined by
		m_bUseSingleContainer : Boolean = true	Shape3D
		m_nDepth : Number = 0	Shape3D
		m_oContainer : Sprite	Shape3D
		m_oEB : BubbleEventBroadcaster	Node
		m_oGeomCenter : Vector	Shape3D
		m_oPreviousOffsetRotation : Vector	ATransformable
		m_tmpMt : Matrix4	ATransformable
		_oScale : Vector	ATransformable
		_p : Vector	ATransformable
		_vOut : Vector	ATransformable
		_vSide : Vector	ATransformable
		_vUp : Vector	ATransformable

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		Cylinder(p_sName:String = null, p_nRadius:Number = 100, p_nHeight:Number = 100, p_nSegmentsW:Number = 8, p_nSegmentsH:Number = 6, p_nTopRadius:Number, p_bExcludeBottom:Boolean = false, p_bExludeTop:Boolean = false, p_bWholeMapping:Boolean = true) Creates a Cylinder primitive or truncated cone.	Cylinder
		addChild(p_oChild:Node):void Adds a new child to this node.	Node
		addEventListener(p_sEvt:String, p_oL:*):void Adds a listener for the specified event.	Node
		CALCUL_RADIUS_FROM_SIDE(p_nSideNumber:uint, p_nSideWidth:uint):Number [static] Calculates the radius depending on the number of sides you want and their width.	Cylinder
		clear():void Clears the graphics object of this object's container.	Shape3D
		clone(p_sName:String = "", p_bKeepTransform:Boolean = false):Shape3D This method returns a clone of this Shape3D.	Shape3D
		cull(p_oScene:Scene3D, p_oFrustum:Frustum, p_oViewMatrix:Matrix4, p_bChanged:Boolean):void Tests this node against the camera frustum to get its visibility.	Shape3D
		destroy():void Destroy this object and all its faces container object is removed, and graphics cleared.	Shape3D
		display(p_oScene:Scene3D, p_oContainer:Sprite = null):void Performs a z-sorting and renders the objects visible polygons.	Shape3D
		generate(... arguments):Geometry3D Generates the geometry for the cylinder.	Cylinder
		getBottom():PrimitiveFace Returns a PrimitiveFace object ( an array of polygons ) defining the bottom face.	Cylinder
		getChildByName(p_sName:String, p_bRecurs:Boolean = false):Node Returns the child node with the specified name.	Node
		getFace(p_nFace:uint):PrimitiveFace Returns a PrimitiveFace object ( an array of polygons ) defining the specified face.	Cylinder
		getPosition(p_sMode:String = "local"):Vector Returns the position of this group or object.	ATransformable
		getTop():PrimitiveFace Returns a PrimitiveFace object ( an array of polygons ) defining the top face.	Cylinder
		hasParent():Boolean Tests if this node has a parent.	Node
		initFrame():void Initiates the local coordinate system for this object.	ATransformable
		isParent(p_oNode:Node):Boolean Tests if the node passed in the argument is parent of this node.	Node
		lookAt(p_nX:Number, p_nY:Number, p_nZ:Number):void Makes this object "look at" the specified position in the parent frame.	ATransformable
		moveForward(p_nD:Number):void Translates this object along its forward vector ( local z ) in the parent frame.	ATransformable
		moveHorizontally(p_nD:Number):void Translates this object parallel to its parent zx plane and in its forward direction.	ATransformable
		moveLateraly(p_nD:Number):void Translates this object laterally in its parent frame.	ATransformable
		moveSideways(p_nD:Number):void Translates this object along its side vector ( local x ) in the parent frame.	ATransformable
		moveUpwards(p_nD:Number):void Translates this object along its up vector ( local y ) in the parent frame.	ATransformable
		moveVertically(p_nD:Number):void Translates this object vertically in ots parent frame.	ATransformable
		perform(p_iOperation:INodeOperation):void Performs an operation on this node and all of its children.	Node
		remove():void Removes this node from the node tree, saving its child nodes.	Node
		removeChildByName(p_sName:String):Boolean Removes the child node with the specified name.	Node
		removeEventListener(p_sEvt:String, p_oL:*):void Removes a listener for the specified event.	Node
		render(p_oScene:Scene3D, p_oCamera:Camera3D):void Renders this 3D object.	Shape3D
		rotateAxis(p_nX:Number, p_nY:Number, p_nZ:Number, p_nAngle:Number):void Rotate this object around the specified axis in the parent frame by the specified angle.	ATransformable
		setPosition(p_nX:Number, p_nY:Number, p_nZ:Number):void Sets the position of this object in coordinates of its parent frame.	ATransformable
		swapCulling():void Changes the backface culling side.	Shape3D
		swapParent(p_oNewParent:Node):void Moves this node to another parent node.	Node
		toString():String Returns a string representation of this object	Shape3D
		translate(p_nX:Number, p_nY:Number, p_nZ:Number):void Translate this object from it's current position with the specified offsets.	ATransformable
		update(p_oScene:Scene3D, p_oModelMatrix:Matrix4, p_bChanged:Boolean):void Updates this node or object.	ATransformable
		updateBoundingVolumes():void Updates the bounding volumes of this object.	Shape3D
		updateTransform():void Updates the transform matrix of the current object/node before it is rendered.	ATransformable

	Method	Defined by
		_onInteraction(p_oEvt:Event):void	Shape3D

	Constant	Defined by
		children : Array The children of this node are stored inside this array.	Node
		DEFAULT_HEIGHT : Number = 100 [static] The default height for a cylinder.	Cylinder
		DEFAULT_RADIUS : Number = 100 [static] The default radius for a cylinder.	Cylinder
		DEFAULT_SCALE : Number = 1 [static] The default scale for a cylinder texture.	Cylinder
		DEFAULT_SEGMENTSH : Number = 6 [static] The default number of vertical segments for a cylinder.	Cylinder
		DEFAULT_SEGMENTSW : Number = 8 [static] The default number of horizontal segments for a cylinder.	Cylinder
		id : uint The unique id of this node in the node graph.	Node
		MIN_SEGMENTSH : Number = 2 [static] The minimum number of vertical segments for a cylinder.	Cylinder
		MIN_SEGMENTSW : Number = 3 [static] The minimum number of horizontal segments for a cylinder.	Cylinder
		modelMatrix : Matrix4 Cached matrix corresponding to the transformation to the 0,0,0 frame system	Node
		viewMatrix : Matrix4 Cached matrix corresponding to the transformation to the camera frame system	Node

Property detail

segmentsH

property

public var segmentsH:Number

The number of vertical segments.

segmentsW

property

public var segmentsW:Number

The number of horizontal segments.

Constructor detail

Cylinder

()

constructor

public function Cylinder(p_sName:String = null, p_nRadius:Number = 100, p_nHeight:Number = 100, p_nSegmentsW:Number = 8, p_nSegmentsH:Number = 6, p_nTopRadius:Number, p_bExcludeBottom:Boolean = false, p_bExludeTop:Boolean = false, p_bWholeMapping:Boolean = true)

Creates a Cylinder primitive or truncated cone.

The cylinder is created at the origin of the world coordinate system, with its axis along the y axis, and with the bottom and top surfaces paralell to the zx plane

All arguments to the constructor have default values, and are optional. If you pass in a top radius, that is different from the bottom radius, a truncated cone is created.

By passing true values to one or both of p_bExcludeBottom and p_bExludeTop, you exclude the bottom and/or top surfaces from being created.

Parameters

	`p_sName:String` (default = `null`) — A string identifier for this object.

	`p_nRadius:Number` (default = `100`) — Radius of the cylinder.

	`p_nHeight:Number` (default = `100`) — Height of the cylinder.

	`p_nSegmentsW:Number` (default = `8`) — Number of horizontal segments.

	`p_nSegmentsH:Number` (default = `6`) — Number of vertical segments.

	`p_nTopRadius:Number` — An optional parameter for cone - or diverging cylinders.

	`p_bExcludeBottom:Boolean` (default = `false`) — If set to true, the bottom face is not created.

	`p_bExludeTop:Boolean` (default = `false`) — If set to true, the top face is not created.

	`p_bWholeMapping:Boolean` (default = `true`) — Specifies how the material applied to the cylinder will be mapped. If set to `false`, the material will be mapped to each individual face, rather than to the whole cylinder.

Method detail

CALCUL_RADIUS_FROM_SIDE

()

method

public static function CALCUL_RADIUS_FROM_SIDE(p_nSideNumber:uint, p_nSideWidth:uint):Number

Calculates the radius depending on the number of sides you want and their width.

[ToDo: Elaborate on this a bit, please :) ]

Parameters

	`p_nSideNumber:uint` — The number of sides the cylinder has

	`p_nSideWidth:uint` — Width of a side

Returns

Number — The radius

generate

()

method

public function generate(... arguments):Geometry3D

Generates the geometry for the cylinder.

Parameters

... arguments

Returns

Geometry3D — The geometry object for the cylinder.

See also

sandy.core.scenegraph.Geometry3D

getBottom

()

method

public function getBottom():PrimitiveFace

Returns a PrimitiveFace object ( an array of polygons ) defining the bottom face.

Returns

PrimitiveFace — The PrimitiveFace object of the bottom face.

See also

PrimitiveFace

getFace

()

method

public function getFace(p_nFace:uint):PrimitiveFace

Returns a PrimitiveFace object ( an array of polygons ) defining the specified face.

Parameters

p_nFace:uint — The requested face

Returns

PrimitiveFace — The PrimitiveFace object of the specified face.

See also

PrimitiveFace

getTop

()

method

public function getTop():PrimitiveFace

Returns a PrimitiveFace object ( an array of polygons ) defining the top face.

Returns

PrimitiveFace — The PrimitiveFace object of the top face.

See also

PrimitiveFace

Constant detail

DEFAULT_HEIGHT

constant

public static const DEFAULT_HEIGHT:Number = 100

The default height for a cylinder.

DEFAULT_RADIUS

constant

public static const DEFAULT_RADIUS:Number = 100

The default radius for a cylinder.

DEFAULT_SCALE

constant

public static const DEFAULT_SCALE:Number = 1

The default scale for a cylinder texture.

DEFAULT_SEGMENTSH

constant

public static const DEFAULT_SEGMENTSH:Number = 6

The default number of vertical segments for a cylinder.

DEFAULT_SEGMENTSW

constant

public static const DEFAULT_SEGMENTSW:Number = 8

The default number of horizontal segments for a cylinder.

MIN_SEGMENTSH

constant

public static const MIN_SEGMENTSH:Number = 2

The minimum number of vertical segments for a cylinder.

MIN_SEGMENTSW

constant

public static const MIN_SEGMENTSW:Number = 3

The minimum number of horizontal segments for a cylinder.

Sandy 3.0 Documentation

Sandy 3.0 Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Cylinder	Properties \| Methods \| Constants

Package	sandy.primitive
Class	public class Cylinder
Inheritance	Cylinder Shape3D ATransformable Node
Implements	Primitive3D
Subclasses	Cone