ElasticNode
@physion/app / Exports / ElasticNode
Class: ElasticNode
Base class for all nodes in Physion.
Hierarchy
↳
ElasticNode
Constructors
constructor
• new ElasticNode(polygons?
, velocity?
, color?
)
Parameters
Name | Type | Default value |
---|---|---|
polygons | Points [] | defaultPolygons |
velocity | IPoint | defaultVelocity |
color | number | defaultColor |
Inherited from
Properties
userData
• userData: any
Inherited from
EVT_CHILD_ADDED
▪ Static
Readonly
EVT_CHILD_ADDED: "childAdded"
The name of the event that is emitted whenever a child is added to this node.
The argument supplied is the child that was just added to this node.
Inherited from
ParticleGroupNode.EVT_CHILD_ADDED
EVT_CHILD_REMOVED
▪ Static
Readonly
EVT_CHILD_REMOVED: "childRemoved"
The name of the event that is emitted whenever a child is removed from this node.
The argument supplied is the child that was just removed from this node.
Inherited from
ParticleGroupNode.EVT_CHILD_REMOVED
EVT_CHILD_REORDERED
▪ Static
Readonly
EVT_CHILD_REORDERED: "childReordered"
The name of the event that is emitted whenever a child of this node is reordered.
The arguments supplied are: (1) The child that was just reordered (2) the old index of the child and (3) the new index of the child.
Inherited from
ParticleGroupNode.EVT_CHILD_REORDERED
EVT_NAME_CHANGED
▪ Static
Readonly
EVT_NAME_CHANGED: "nameChanged"
The name of the event that is emitted whenever the name of this object changes.
The argument suplied is the new name of the object.
Inherited from
ParticleGroupNode.EVT_NAME_CHANGED
EVT_PROPERTY_CHANGED
▪ Static
Readonly
EVT_PROPERTY_CHANGED: "propertyChanged"
The name of the event that is emitted whenever a property of this object changes.
The arguments supplied are: (1) The name of the property that has changed and (2) the new value of that property.
Inherited from
ParticleGroupNode.EVT_PROPERTY_CHANGED
EVT_TRANSFORM_CHANGED
▪ Static
Readonly
EVT_TRANSFORM_CHANGED: "transformChanged"
The name of the event that is emitted whenever the x, y or angle properties of this Node are changed.
Note that this event is not emitted when x, y or angle properties are changed as a result of
an update()
.
Inherited from
ParticleGroupNode.EVT_TRANSFORM_CHANGED
Accessors
alpha
• get
alpha(): number
Node's alpha
This value is between 0 (transparent) and 1.0 (opaque). This property can be considered as the "master" opacity of the node. Defaults to 1 (fully opaque)
Returns
number
Inherited from
ParticleGroupNode.alpha
• set
alpha(v
): void
Parameters
Name | Type |
---|---|
v | number |
Returns
void
Inherited from
ParticleGroupNode.alpha
angle
• get
angle(): number
Node's angle (in degrees)
Returns
number
Inherited from
ParticleGroupNode.angle
• set
angle(v
): void
Parameters
Name | Type |
---|---|
v | number |
Returns
void
Inherited from
ParticleGroupNode.angle
childCount
• get
childCount(): number
Returns the number of children this node contains.
Returns
number
Inherited from
ParticleGroupNode.childCount
children
• get
children(): Node
[]
Returns the children of this node.
Returns
Node
[]
Inherited from
ParticleGroupNode.children
flags
• get
flags(): CoreObjectFlags
Returns
CoreObjectFlags
Inherited from
ParticleGroupNode.flags
id
• get
id(): string
Object's (unique) id
Note that the id of the object cannot be set (it is automatically assigned upon construction)
Returns
string
Inherited from
ParticleGroupNode.id
internalState
• get
internalState(): IParticleGroupState
Returns
IParticleGroupState
Inherited from
ParticleGroupNode.internalState
• set
internalState(v
): void
Parameters
Name | Type |
---|---|
v | IParticleGroupState |
Returns
void
Inherited from
ParticleGroupNode.internalState
metaObject
• get
metaObject(): MetaObject
Returns the MetaObject that describes this class
Returns
Overrides
ParticleGroupNode.metaObject
name
• get
name(): string
The object's name
The object's name is a free text value which defaults to an empty string.
Note that when the name of the object changes, the EVT_NAME_CHANGED signal will be emitted.
Returns
string
Inherited from
ParticleGroupNode.name
• set
name(v
): void
Parameters
Name | Type |
---|---|
v | string |
Returns
void
Inherited from
ParticleGroupNode.name
parent
• get
parent(): undefined
| Node
Returns the parent of this node (or undefined if this node has no parent).
Returns
undefined
| Node
Inherited from
ParticleGroupNode.parent
scene
• get
scene(): undefined
| Scene
Returns
undefined
| Scene
Inherited from
ParticleGroupNode.scene
scripts
• get
scripts(): string
[]
Returns
string
[]
Inherited from
ParticleGroupNode.scripts
• set
scripts(v
): void
Parameters
Name | Type |
---|---|
v | string [] |
Returns
void
Inherited from
ParticleGroupNode.scripts
spriteBlendMode
• get
spriteBlendMode(): BLEND_MODES
Returns
BLEND_MODES
Inherited from
ParticleGroupNode.spriteBlendMode
• set
spriteBlendMode(v
): void
Parameters
Name | Type |
---|---|
v | BLEND_MODES |
Returns
void
Inherited from
ParticleGroupNode.spriteBlendMode
spriteScale
• get
spriteScale(): number
Returns
number
Inherited from
ParticleGroupNode.spriteScale
• set
spriteScale(v
): void
Parameters
Name | Type |
---|---|
v | number |
Returns
void
Inherited from
ParticleGroupNode.spriteScale
x
• get
x(): number
Node's x position (in meters)
Returns
number
Inherited from
ParticleGroupNode.x
• set
x(v
): void
Parameters
Name | Type |
---|---|
v | number |
Returns
void
Inherited from
ParticleGroupNode.x
y
• get
y(): number
Node's y position (in meters)
Returns
number
Inherited from
ParticleGroupNode.y
• set
y(v
): void
Parameters
Name | Type |
---|---|
v | number |
Returns
void
Inherited from
ParticleGroupNode.y
Methods
addChild
▸ addChild(child
): boolean
Adds the given child to this node.
If the given child is already contained in this node or it already has a parent then this method will fail (false will be returned).
Otherwise the child will be added to this node and the EVT_CHILD_ADDED signal will be emitted.
Parameters
Name | Type | Description |
---|---|---|
child | Node | The child to be added to this node. |
Returns
boolean
True on success otherwise false.
Inherited from
addChildren
▸ addChildren(children
): void
Convenience method for adding multiple children to this node.
Parameters
Name | Type |
---|---|
children | Node [] |
Returns
void
Inherited from
canAddChild
▸ canAddChild(child
): boolean
Returns true if the given child can be added to this node
Parameters
Name | Type |
---|---|
child | Node |
Returns
boolean
Inherited from
canRemoveChild
▸ canRemoveChild(child
): boolean
Returns true if the given child can be removed from this node
Parameters
Name | Type |
---|---|
child | Node |
Returns
boolean
Inherited from
ParticleGroupNode.canRemoveChild
childIndex
▸ childIndex(child
): number
Returns the index of the given child (or -1 if child is not contained in thie node).
Parameters
Name | Type |
---|---|
child | Node |
Returns
number
Inherited from
clone
▸ clone(): Node
Creates and returns a clone of this node.
The clone returned will have the same property values as this node except from its id.
Returns
A clone of this node.
Inherited from
containsChild
▸ containsChild(child
): boolean
Returns true if this node contains the given child
Parameters
Name | Type |
---|---|
child | Node |
Returns
boolean
Inherited from
ParticleGroupNode.containsChild
destroy
▸ destroy(): void
Returns
void
Inherited from
findAncestorByClassName
▸ findAncestorByClassName(className
): undefined
| Node
Parameters
Name | Type |
---|---|
className | string |
Returns
undefined
| Node
Inherited from
ParticleGroupNode.findAncestorByClassName
findChildById
▸ findChildById(id
): undefined
| Node
Finds and returns the child with the given id.
Parameters
Name | Type | Description |
---|---|---|
id | string | The id of the child to search for. |
Returns
undefined
| Node
The child with the given id or undefined if no such child exists.
Inherited from
ParticleGroupNode.findChildById
findChildByName
▸ findChildByName(name
): undefined
| Node
Finds and returns the first child node with the given name.
Parameters
Name | Type | Description |
---|---|---|
name | string | The name of the child to search for. |
Returns
undefined
| Node
The first child with the given name or undefined if no such child exists.
Inherited from
ParticleGroupNode.findChildByName
findDescendantById
▸ findDescendantById(id
): undefined
| Node
Finds and returns the descendant with the given id.
Parameters
Name | Type | Description |
---|---|---|
id | string | The id of the descendant to search for. |
Returns
undefined
| Node
The descendant with the given id or undefined if no such descendant exists.
Inherited from
ParticleGroupNode.findDescendantById
findSceneAssetById
▸ findSceneAssetById(id
): undefined
| Asset
Finds and returns the asset specified by the given id. Note that the node needs to be parented to a Scene for this method to work.
Parameters
Name | Type | Description |
---|---|---|
id | string | The id of the asset to search for. |
Returns
undefined
| Asset
The matched Asset of undefined if no such asset exists in the scene.
Inherited from
ParticleGroupNode.findSceneAssetById
findSceneNode
▸ findSceneNode(): undefined
| Node
Uses the findAncestorByClassName to find the Scene that this node is added to. If this node has not yet been added to a scene then this method will return undefined.
Returns
undefined
| Node
Inherited from
ParticleGroupNode.findSceneNode
getAncestors
▸ getAncestors(): Node
[]
Returns the ancestors of this node
Returns
Node
[]
Inherited from
ParticleGroupNode.getAncestors
getAssetIds
▸ getAssetIds(): string
[]
Returns the ids of the assets that are used by this Node.
Returns
string
[]
The ids of the assets that are used by this Node.
Inherited from
getBoundingRect
▸ getBoundingRect(): Rectangle
Returns the bounding rectangle of this node in local coordinates.
The default implementation returns an empty rectangle but subclasses can re-implement this method to return an accurate bounding rectangle.
Returns
Rectangle
Inherited from
ParticleGroupNode.getBoundingRect
getDescendants
▸ getDescendants(): Node
[]
Returns the descendants of this node.
A descendant is node that has this node as an ancestor. Consider for example the following tree of nodes:
- NodeA
- NodeB
- NodeD
- NodeE
- NodeC
- NodeB
If we ask for the descendants of NodeA we'll get back: [NodeB, NodeD, NodeE, NodeC]
Returns
Node
[]
A list of this node's descendants
Inherited from
ParticleGroupNode.getDescendants
getExtras
▸ getExtras(): any
Returns any extra data that this object needs to save during serialization.
In some cases an object might need to save some extra data without necessarily this extra data being part of its state (e.g. the AssetsLibrary of a Scene). In these cases subclasses can re-implement this method and return the data required.
The default implementation returns undefined
meaning that no extra data
needs to be saved during serialization.
Returns
any
Inherited from
getFilteredDescendants
▸ getFilteredDescendants<T
>(cls
): T
[]
Returns the descendants of this node that are instances of the class cls
Type parameters
Name | Type |
---|---|
T | extends Node <T > |
Parameters
Name | Type |
---|---|
cls | Constructor <T > |
Returns
T
[]
Inherited from
ParticleGroupNode.getFilteredDescendants
getFilteredDescendantsByClassName
▸ getFilteredDescendantsByClassName(className
): Node
[]
Returns the descendants of this node that are instances of the class className
Parameters
Name | Type |
---|---|
className | string |
Returns
Node
[]
Inherited from
ParticleGroupNode.getFilteredDescendantsByClassName
getLocalTransform
▸ getLocalTransform(): Matrix
Returns a copy of this node's (local) transformation matrix.
Returns
Matrix
Inherited from
ParticleGroupNode.getLocalTransform
getPosition
▸ getPosition(): IPoint
Convenience method which returns the node's position as a x,y object
Returns
IPoint
Inherited from
getSceneBoundingRect
▸ getSceneBoundingRect(): Rectangle
Returns the bounding rect of this node in scene coordinates.
Returns
Rectangle
Inherited from
ParticleGroupNode.getSceneBoundingRect
getScenePosition
▸ getScenePosition(): IPoint
Returns the Node's position in Scene coordinates.
Returns
IPoint
Inherited from
ParticleGroupNode.getScenePosition
getSceneTransform
▸ getSceneTransform(): Matrix
Returns a copy of this node's scene transformation matrix. Use this matrix to map coordinates from this node's local coordinate system to the scene's coordinate system. To map coordinates from the scene, you must first invert the returned matrix.
Unlike getLocalTransform(), which returns only the local transformation, this function includes the node's (and any parents') position, and all the transfomation properties.
Returns
Matrix
Inherited from
ParticleGroupNode.getSceneTransform
getShape
▸ getShape(): Polygon
Returns the shape of this Node in local coordinates.
Note that the returned shape might be empty.
The shape of a Node is used for many things, including boolean operations and selection.
The default implementation calls getBoundingRect() to return a simple rectangular shape, but subclasses can reimplement this function to return a more accurate shape for non-rectangular items.
Returns
Polygon
Inherited from
getSnapPoints
▸ getSnapPoints(snapMode
): ISnapPoint
[]
Snap Points
Parameters
Name | Type |
---|---|
snapMode | number |
Returns
ISnapPoint
[]
Inherited from
ParticleGroupNode.getSnapPoints
getState
▸ getState(minified?
): any
Returns this object's state
The object's state is an object containing key/value pairs corresponding to this object's properties. For example:
{
id: "Ssba4ch5ruok",
name: "Circle",
radius: 2,
// ...
}
To avoid including properties that are currently in their default value you can set minified = true when calling getState.
Note that read-only properties are not part of the object's state (with the exception of the id)
Parameters
Name | Type | Default value | Description |
---|---|---|---|
minified | boolean | false | Whether to return a minified state or not |
Returns
any
Inherited from
getTransformedShape
▸ getTransformedShape(): Polygon
Returns the shape of this Node in scene coordinates.
Note that the returned shape might be empty.
Returns
Polygon
Inherited from
ParticleGroupNode.getTransformedShape
index
▸ index(): number
Returns the index of this Node relatively to its parent. If this Node has no parent then -1 is returned.
Returns
number
Inherited from
initNode
▸ initNode(x?
, y?
, angle?
): void
Convenience method for setting node's x, y and angle
Parameters
Name | Type | Default value |
---|---|---|
x | number | 0 |
y | number | 0 |
angle | number | 0 |
Returns
void
Inherited from
insertChild
▸ insertChild(child
, index
): boolean
Parameters
Name | Type |
---|---|
child | Node |
index | number |
Returns
boolean
Inherited from
isDestroyed
▸ isDestroyed(): boolean
Returns true if this node has been destroyed via destroy(). A destroyed Node should not be used.
Returns
boolean
Inherited from
isSelected
▸ isSelected(): boolean
Returns true if this node is currently selected.
Returns
boolean
Inherited from
move
▸ move(d
): void
Moves this node by the given d.x, d.y
Parameters
Name | Type |
---|---|
d | IPoint |
Returns
void
Inherited from
moveParticles
▸ moveParticles(d
): void
Parameters
Name | Type |
---|---|
d | IPoint |
Returns
void
Inherited from
ParticleGroupNode.moveParticles
removeAllChildren
▸ removeAllChildren(): void
Convenience method which removes all children of this node
Returns
void
Inherited from
ParticleGroupNode.removeAllChildren
removeChild
▸ removeChild(child
): boolean
Parameters
Name | Type |
---|---|
child | Node |
Returns
boolean
Inherited from
removeChildren
▸ removeChildren(children
): void
Convenience method for removing multiple children from this node.
Parameters
Name | Type |
---|---|
children | Node [] |
Returns
void
Inherited from
ParticleGroupNode.removeChildren
reorderChild
▸ reorderChild(child
, newIndex
): boolean
Moves a child node to a different position (order) among the other children If the operation is successul then the EVT_CHILD_REORDERED signal will be emitted
Parameters
Name | Type | Description |
---|---|---|
child | Node | The child node to be moved |
newIndex | number | The new index where the child node will be moved |
Returns
boolean
true on success otherwise false
Inherited from
ParticleGroupNode.reorderChild
setExtras
▸ setExtras(_x
): boolean
Sets any extra data that this object needs during de-serialization.
Returns true on success, otherwise returns false.
The default implementation does nothing and returns true.
Parameters
Name | Type |
---|---|
_x | any |
Returns
boolean
Inherited from
setFlag
▸ setFlag(flag
, on?
): void
Parameters
Name | Type | Default value |
---|---|---|
flag | CoreObjectFlags | undefined |
on | boolean | true |
Returns
void
Inherited from
setPosition
▸ setPosition(v
): void
Convenience method for setting the node's position to the given x,y
Parameters
Name | Type |
---|---|
v | IPoint |
Returns
void
Inherited from
setSelected
▸ setSelected(selected
): void
Parameters
Name | Type |
---|---|
selected | boolean |
Returns
void
Inherited from
setState
▸ setState(state
, updateId?
): boolean
Sets the object's state
Parameters
Name | Type | Default value | Description |
---|---|---|---|
state | any | undefined | The state to be set |
updateId | boolean | true | Whether to also update the id property |
Returns
boolean
True on success otherwise false
Inherited from
testFlag
▸ testFlag(flag
): boolean
Parameters
Name | Type |
---|---|
flag | CoreObjectFlags |
Returns
boolean
Inherited from
toGlobal
▸ toGlobal(position
, skipUpdate?
): IPointData
Parameters
Name | Type |
---|---|
position | IPoint |
skipUpdate? | boolean |
Returns
IPointData
Inherited from
toLocal
▸ toLocal(position
, from?
, skipUpdate?
): IPointData
Parameters
Name | Type |
---|---|
position | IPoint |
from? | Node |
skipUpdate? | boolean |
Returns
IPointData
Inherited from
update
▸ update(delta
): void
Updates this node.
The default update will do the following:
- If this node has a script attached to it then it will call the script's update method
- Call update for each child of this node.
Parameters
Name | Type | Description |
---|---|---|
delta | number | Not currently used |
Returns
void