Packagesandy.core.scenegraph
Classpublic class Group
InheritanceGroup Inheritance Node

The Group class is used for branch nodes in the Sandy object tree.

This class is fianl, and can not be sub classed

This group binds together, but can not transform its children.
To transform collections of objects, you should add them to a transform group.

See also

sandy.core.scenegraph.TransformGroup

Public Properties
 PropertyDefined by
 Inheritedappearance : Appearance
Set that appearance to all the children of that node
Node
 InheritedboundingBox : BBox
The bounding box of this node IMPORTANT: Do not modify it unless you perfectly know what you are doing
Node
 InheritedboundingSphere : BSphere
The bounding sphere of this node IMPORTANT: Do not modify it unless you perfectly know what you are doing
Node
 Inheritedbroadcaster : BubbleEventBroadcaster
The broadcaster

The broadcaster is used to send events to listeners.
This property is a BubbleEventBroadcaster.

Node
 Inheritedchanged : Boolean = false
This property set the cache status of the current node.
Node
 Inheritedculled : CullingState
This property represent the culling state of the current node.
Node
 InheritedenableBackFaceCulling : Boolean
Change the backface culling state to all the shapes objects in the children list
Node
 InheritedenableEvents : Boolean
Enable event handling to all the children objects that can broadcast bubbling events
Node
 InheritedenableInteractivity : Boolean
Change the interactivity of all the children
Node
 Inheritedname : String
Name of this node.
Node
 Inheritedparent : Node
The parent node of this node.
Node
 Inheritedscene : Scene3D = null
Reference to the scene is it linked to.
Node
 InheriteduseSingleContainer : Boolean
Make all the Shape3D and descendants children react to this value.
Node
 Inheritedvisible : Boolean = true
Specify the visibility of this node.
Node
Protected Properties
 PropertyDefined by
 Inheritedm_oEB : BubbleEventBroadcaster
Node
Public Methods
 MethodDefined by
  
Group(p_sName:String = "")
Creates a branch group.
Group
 Inherited
addChild(p_oChild:Node):void
Adds a new child to this node.
Node
 Inherited
addEventListener(p_sEvt:String, p_oL:*):void
Adds a listener for the specified event.
Node
  
clone(p_sName:String):Group
Group
  
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.
Group
 Inherited
destroy():void
Delete this node and all its child nodes.
Node
 Inherited
getChildByName(p_sName:String, p_bRecurs:Boolean = false):Node
Returns the child node with the specified name.
Node
 Inherited
hasParent():Boolean
Tests if this node has a parent.
Node
 Inherited
isParent(p_oNode:Node):Boolean
Tests if the node passed in the argument is parent of this node.
Node
 Inherited
perform(p_iOperation:INodeOperation):void
Performs an operation on this node and all of its children.
Node
 Inherited
remove():void
Removes this node from the node tree, saving its child nodes.
Node
 Inherited
removeChildByName(p_sName:String):Boolean
Removes the child node with the specified name.
Node
 Inherited
removeEventListener(p_sEvt:String, p_oL:*):void
Removes a listener for the specified event.
Node
  
render(p_oScene:Scene3D, p_oCamera:Camera3D):void
Renders all children of this group.
Group
 Inherited
swapParent(p_oNewParent:Node):void
Moves this node to another parent node.
Node
  
toString():String
Group
 Inherited
update(p_oScene:Scene3D, p_oModelMatrix:Matrix4, p_bChanged:Boolean):void
Updates this node.
Node
Public Constants
 ConstantDefined by
 Inheritedchildren : Array
The children of this node are stored inside this array.
Node
 Inheritedid : uint
The unique id of this node in the node graph.
Node
 InheritedmodelMatrix : Matrix4
Cached matrix corresponding to the transformation to the 0,0,0 frame system
Node
 InheritedviewMatrix : Matrix4
Cached matrix corresponding to the transformation to the camera frame system
Node
Constructor detail
Group()constructor
public function Group(p_sName:String = "")

Creates a branch group.

Parameters
p_sName:String (default = "") — A string identifier for this object
Method detail
clone()method
public function clone(p_sName:String):GroupParameters
p_sName:String

Returns
Group
cull()method 
public override function 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.

If this node and its children are not within the frustum, the node is culled and will not be displayed.

This method also updates the bounding volumes to make the more accurate culling system possible.
First the bounding sphere is updated, and if intersecting, the bounding box is updated to perform the more precise culling.

[MANDATORY] The update method must be called first!

Parameters
p_oScene:Scene3D — The current scene
 
p_oFrustum:Frustum — The frustum of the current camera
 
p_oViewMatrix:Matrix4 — The view martix of the curren camera
 
p_bChanged:Boolean
render()method 
public override function render(p_oScene:Scene3D, p_oCamera:Camera3D):void

Renders all children of this group.

Parameters
p_oScene:Scene3D — The current scene
 
p_oCamera:Camera3D — The current camera
toString()method 
public override function toString():String

Returns
String



Sandy 3.0 Documentation