@physion/app / Exports / CapsuleNode
Class: CapsuleNode
This is the base class for all bodies.
Hierarchy
-
↳
CapsuleNode
Constructors
constructor
• new CapsuleNode(width?, height?): CapsuleNode
Parameters
| Name | Type | Default value |
|---|---|---|
width | number | defaultWidth |
height | number | defaultHeight |
Returns
Overrides
Properties
userData
• userData: Record<string, unknown>
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
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
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
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 CoreObject.name of the object.
Inherited from
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
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
BodyNode.EVT_TRANSFORM_CHANGED
ID_LENGTH
▪ Static Readonly ID_LENGTH: 12
Inherited from
MAX_NAME_LENGTH
▪ Static Readonly MAX_NAME_LENGTH: 128
Inherited from
MIN_HEIGHT
▪ Static Readonly MIN_HEIGHT: 0.05
MIN_WIDTH
▪ Static Readonly MIN_WIDTH: 0.05
Accessors
active
• get active(): boolean
Returns true if this body is active, otherwise returns false.
An inactive body will be visualized but it won't participate in the simulation.
Returns
boolean
Inherited from
BodyNode.active
• set active(v): void
Sets this body's active property
Parameters
| Name | Type |
|---|---|
v | boolean |
Returns
void
Inherited from
BodyNode.active
allowSleep
• get allowSleep(): boolean
Returns true if this body is allowed to sleep, otherwise returns false.
By default, all bodies are allowed to sleep. This basically means that when a body has come to rest and it has no collisions then it will go to sleep. Setting a body to sleep reduces then number of object we have to simulated (thus increasing performance).
Returns
boolean
Inherited from
BodyNode.allowSleep
• set allowSleep(v): void
Sets this body's allowSleep property
Parameters
| Name | Type |
|---|---|
v | boolean |
Returns
void
Inherited from
BodyNode.allowSleep
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
BodyNode.alpha
• set alpha(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.alpha
angle
• get angle(): number
Returns the angle (in degrees) of this body
Returns
number
Inherited from
BodyNode.angle
• set angle(v): void
Sets the angle (in degrees) of this body
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.angle
angularDamping
• get angularDamping(): number
Returns
number
Inherited from
BodyNode.angularDamping
• set angularDamping(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.angularDamping
angularVelocity
• get angularVelocity(): number
Returns
number
Inherited from
BodyNode.angularVelocity
• set angularVelocity(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.angularVelocity
blendMode
• get blendMode(): BLEND_MODES
Returns
BLEND_MODES
Inherited from
BodyNode.blendMode
• set blendMode(v): void
Parameters
| Name | Type |
|---|---|
v | BLEND_MODES |
Returns
void
Inherited from
BodyNode.blendMode
body
• get body(): undefined | b2Body
Returns
undefined | b2Body
Inherited from
BodyNode.body
bodyType
• get bodyType(): BodyType
Returns the body type of this body.
Returns
BodyType
Inherited from
BodyNode.bodyType
• set bodyType(v): void
Sets this body's bodyType property
Parameters
| Name | Type |
|---|---|
v | BodyType |
Returns
void
Inherited from
BodyNode.bodyType
boxSize
• get boxSize(): ISize
Returns
ISize
bullet
• get bullet(): boolean
Returns true if this body is a bullet, otherwise returns false.
This property only affects dynamic bodies. If a dynamic body is set to be a bullet then continuous collision detection (CCD) will be used and scenarios where a fast moving object tunels through other bodies are avoided. Note that bullets are more computational expensive.
Returns
boolean
Inherited from
BodyNode.bullet
• set bullet(v): void
Sets this body's bullet property
Parameters
| Name | Type |
|---|---|
v | boolean |
Returns
void
Inherited from
BodyNode.bullet
childCount
• get childCount(): number
Returns the number of children this node contains.
Returns
number
Inherited from
BodyNode.childCount
children
• get children(): Node[]
Returns the children of this node.
Returns
Node[]
Inherited from
BodyNode.children
density
• get density(): number
Returns
number
Overrides
BodyNode.density
• set density(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Overrides
BodyNode.density
fillAlpha
• get fillAlpha(): number
Returns
number
Inherited from
BodyNode.fillAlpha
• set fillAlpha(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.fillAlpha
fillColor
• get fillColor(): number
Returns
number
Inherited from
BodyNode.fillColor
• set fillColor(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.fillColor
fillMatrix
• get fillMatrix(): IMatrix
Returns
IMatrix
Inherited from
BodyNode.fillMatrix
• set fillMatrix(v): void
Parameters
| Name | Type |
|---|---|
v | IMatrix |
Returns
void
Inherited from
BodyNode.fillMatrix
fillStyle
• get fillStyle(): FillStyle
Returns
FillStyle
Inherited from
BodyNode.fillStyle
fillTexture
• get fillTexture(): string
Returns
string
Inherited from
BodyNode.fillTexture
• set fillTexture(v): void
Parameters
| Name | Type |
|---|---|
v | string |
Returns
void
Inherited from
BodyNode.fillTexture
filterCategoryBits
• get filterCategoryBits(): number
Returns
number
Inherited from
BodyNode.filterCategoryBits
• set filterCategoryBits(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.filterCategoryBits
filterGroupIndex
• get filterGroupIndex(): number
Returns
number
Inherited from
BodyNode.filterGroupIndex
• set filterGroupIndex(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.filterGroupIndex
filterMaskBits
• get filterMaskBits(): number
Returns
number
Inherited from
BodyNode.filterMaskBits
• set filterMaskBits(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.filterMaskBits
fixedRotation
• get fixedRotation(): boolean
Returns true if this body has fixed rotation, otherwise returns false.
When a body has fixed rotation then it will maintain its original rotation.
Returns
boolean
Inherited from
BodyNode.fixedRotation
• set fixedRotation(v): void
Sets this body's fixedRotation property
Parameters
| Name | Type |
|---|---|
v | boolean |
Returns
void
Inherited from
BodyNode.fixedRotation
fixtures
• get fixtures(): b2Fixture[]
Returns
b2Fixture[]
Inherited from
BodyNode.fixtures
flags
• get flags(): CoreObjectFlags
Returns
CoreObjectFlags
Inherited from
BodyNode.flags
fontSize
• get fontSize(): number
Returns
number
• set fontSize(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
freeBodyDiagram
• get freeBodyDiagram(): IFreeBodyDiagram
The forces drawn on top of this body, keyed by types.ForceKey. See FreeBodyDiagramMixin.
Returns
IFreeBodyDiagram
Inherited from
BodyNode.freeBodyDiagram
• set freeBodyDiagram(v): void
Parameters
| Name | Type |
|---|---|
v | IFreeBodyDiagram |
Returns
void
Inherited from
BodyNode.freeBodyDiagram
friction
• get friction(): number
Returns
number
Inherited from
BodyNode.friction
• set friction(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.friction
graphics
• get graphics(): Graphics
Returns
Graphics
Inherited from
BodyNode.graphics
gravityScale
• get gravityScale(): number
Returns
number
Inherited from
BodyNode.gravityScale
• set gravityScale(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.gravityScale
height
• get height(): number
Returns
number
• set height(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
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
BodyNode.id
lineAlignment
• get lineAlignment(): number
Returns
number
Inherited from
BodyNode.lineAlignment
• set lineAlignment(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void
Inherited from
BodyNode.lineAlignment
lineAlpha
• get lineAlpha(): number
The line alpha used when drawing the graphics.
Returns
number
Inherited from
BodyNode.lineAlpha
• set lineAlpha(v): void
Parameters
| Name | Type |
|---|---|
v | number |
Returns
void