Class PhysicsShapeCylinder

Helper object to create a cylinder shape

Hierarchy

PhysicsShape
- PhysicsShapeCylinder

Index

Constructors

constructor

Properties

_pluginData

Accessors

Methods

Constructors

constructor

new PhysicsShapeCylinder(pointA: Vector3, pointB: Vector3, radius: number, scene: Scene): PhysicsShapeCylinder

Overrides PhysicsShape.constructor
- Defined in .temp/docdirectory/doc.d.ts:93700
Parameters
- pointA: Vector3
  
  Starting point that defines the cylinder segment
- pointB: Vector3
  
  ending point of that same segment
- radius: number
  
  radius
- scene: Scene
  
  scene to attach to
Returns PhysicsShapeCylinder

Properties

_pluginData Search playground for _pluginData

_pluginData: any

V2 Physics plugin private data for single shape

Accessors

density

get density(): number
set density(density: number): void

Inherited from PhysicsShape.density
- Defined in .temp/docdirectory/doc.d.ts:93611
Returns the density of the physics shape.

Returns number
The density of the physics shape.
Inherited from PhysicsShape.density
- Defined in .temp/docdirectory/doc.d.ts:93606
Sets the density of the physics shape.

Parameters
- density: number
  
  The density of the physics shape.
Returns void

filterCollideMask

get filterCollideMask(): number
set filterCollideMask(collideMask: number): void

Inherited from PhysicsShape.filterCollideMask
- Defined in .temp/docdirectory/doc.d.ts:93591
Sets the collide mask of a shape. This is a bitfield of arbitrary "categories" to which this shape collides with. Given two shapes, the engine will check if the collide mask and membership overlap: shapeA.filterMembershipMask & shapeB.filterCollideMask

If this value is zero (i.e. shapeB only collides with categories which shapeA is not a member of) then the shapes will not collide.

Note, the engine will also perform the same test with shapeA and shapeB swapped; the shapes will not collide if either shape has a collideMask which prevents collision with the other shape.

Returns number
Bitmask of categories that this shape should collide with
Inherited from PhysicsShape.filterCollideMask
- Defined in .temp/docdirectory/doc.d.ts:93586
Sets the collide mask of a shape. This is a bitfield of arbitrary "categories" to which this shape collides with. Given two shapes, the engine will check if the collide mask and membership overlap: shapeA.filterMembershipMask & shapeB.filterCollideMask

If this value is zero (i.e. shapeB only collides with categories which shapeA is not a member of) then the shapes will not collide.

Note, the engine will also perform the same test with shapeA and shapeB swapped; the shapes will not collide if either shape has a collideMask which prevents collision with the other shape.

Parameters
- collideMask: number
  
  Bitmask of categories this shape should collide with
Returns void

filterMembershipMask

get filterMembershipMask(): number
set filterMembershipMask(membershipMask: number): void

Inherited from PhysicsShape.filterMembershipMask
- Defined in .temp/docdirectory/doc.d.ts:93570
Get the membership mask of a shape.

Returns number
Bitmask of categories which this shape is a member of.
Inherited from PhysicsShape.filterMembershipMask
- Defined in .temp/docdirectory/doc.d.ts:93565
Set the membership mask of a shape. This is a bitfield of arbitrary "categories" to which the shape is a member. This is used in combination with the collide mask to determine if this shape should collide with another.

Parameters
- membershipMask: number
  
  Bitfield of categories of this shape.
Returns void

isTrigger

get isTrigger(): boolean
set isTrigger(isTrigger: boolean): void

Inherited from PhysicsShape.isTrigger
- Defined in .temp/docdirectory/doc.d.ts:93646
Returns boolean
Inherited from PhysicsShape.isTrigger
- Defined in .temp/docdirectory/doc.d.ts:93645
Parameters
- isTrigger: boolean
Returns void

material

get material(): PhysicsMaterial
set material(material: PhysicsMaterial): void

Inherited from PhysicsShape.material
- Defined in .temp/docdirectory/doc.d.ts:93601
Returns the material of the physics shape.

Returns PhysicsMaterial
The material of the physics shape.
Inherited from PhysicsShape.material
- Defined in .temp/docdirectory/doc.d.ts:93596
Parameters
- material: PhysicsMaterial
Returns void

type

get type(): PhysicsShapeType

Inherited from PhysicsShape.type
- Defined in .temp/docdirectory/doc.d.ts:93556
Returns the type of the physics shape.

Returns PhysicsShapeType
The type of the physics shape.

Methods

addChild Search playground for addChild

addChild(newChild: PhysicsShape, translation?: Vector3, rotation?: Quaternion, scale?: Vector3): void

Inherited from PhysicsShape.addChild
- Defined in .temp/docdirectory/doc.d.ts:93629
Adds a child shape to a container with an optional transform

Parameters
- newChild: PhysicsShape
  
  The new PhysicsShape to add
- Optional translation: Vector3
  
  Optional position of the child shape relative to this shape
- Optional rotation: Quaternion
  
  Optional rotation of the child shape relative to this shape
- Optional scale: Vector3
  
  Optional scale of the child shape relative to this shape
Returns void

addChildFromParent Search playground for addChildFromParent

addChildFromParent(parentTransform: TransformNode, newChild: PhysicsShape, childTransform: TransformNode): void

Inherited from PhysicsShape.addChildFromParent
- Defined in .temp/docdirectory/doc.d.ts:93621
Utility to add a child shape to this container, automatically computing the relative transform between the container shape and the child instance.

Parameters
- parentTransform: TransformNode
  
  The transform node associated with this shape
- newChild: PhysicsShape
  
  The new PhysicsShape to add
- childTransform: TransformNode
  
  The transform node associated with the child shape
Returns void

dispose Search playground for dispose

dispose(): void

Inherited from PhysicsShape.dispose
- Defined in .temp/docdirectory/doc.d.ts:93650
Dispose the shape and release its associated resources.

Returns void

getBoundingBox Search playground for getBoundingBox

getBoundingBox(): BoundingBox

Inherited from PhysicsShape.getBoundingBox
- Defined in .temp/docdirectory/doc.d.ts:93644
Returns the bounding box of the physics shape.

Returns BoundingBox
The bounding box of the physics shape.

getClassName Search playground for getClassName

getClassName(): string

Inherited from PhysicsShape.getClassName
- Defined in .temp/docdirectory/doc.d.ts:93551
Returns the string "PhysicsShape".

Returns string
"PhysicsShape"

getNumChildren Search playground for getNumChildren

getNumChildren(): number

Inherited from PhysicsShape.getNumChildren
- Defined in .temp/docdirectory/doc.d.ts:93639
Returns the number of children of a physics shape.

Returns number
The number of children of a physics shape.

removeChild Search playground for removeChild

removeChild(childIndex: number): void

Inherited from PhysicsShape.removeChild
- Defined in .temp/docdirectory/doc.d.ts:93634
Removes a child shape from this shape.

Parameters
- childIndex: number
  
  The index of the child shape to remove
Returns void

Static FromMesh Search playground for FromMesh

FromMesh(mesh: AbstractMesh): PhysicsShapeCylinder

- Defined in .temp/docdirectory/doc.d.ts:93706
Derive an approximate cylinder from the mesh. Note, this is not the optimal bounding cylinder.

Parameters
- mesh: AbstractMesh
  
  Node from which to derive a cylinder shape
Returns PhysicsShapeCylinder

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

pointA: Vector3

pointB: Vector3

radius: number

scene: Scene

Returns PhysicsShapeCylinder

Properties

_pluginDataSearch playground for _pluginData

Accessors

density

Returns number

Parameters

density: number

Returns void

filterCollideMask

Returns number

Parameters

collideMask: number

Returns void

filterMembershipMask

Returns number

Parameters

membershipMask: number

Returns void

isTrigger

Returns boolean

Parameters

isTrigger: boolean

Returns void

material

Returns PhysicsMaterial

Parameters

material: PhysicsMaterial

Returns void

type

Returns PhysicsShapeType

Methods

addChildSearch playground for addChild

Parameters

newChild: PhysicsShape

Optional translation: Vector3

Optional rotation: Quaternion

Optional scale: Vector3

Returns void

addChildFromParentSearch playground for addChildFromParent

Parameters

parentTransform: TransformNode

newChild: PhysicsShape

childTransform: TransformNode

Returns void

disposeSearch playground for dispose

Returns void

getBoundingBoxSearch playground for getBoundingBox

Returns BoundingBox

getClassNameSearch playground for getClassName

Returns string

getNumChildrenSearch playground for getNumChildren

Returns number

removeChildSearch playground for removeChild

Parameters

childIndex: number

Returns void

Static FromMeshSearch playground for FromMesh

Parameters

mesh: AbstractMesh

Returns PhysicsShapeCylinder

_pluginData Search playground for _pluginData

addChild Search playground for addChild

addChildFromParent Search playground for addChildFromParent

dispose Search playground for dispose

getBoundingBox Search playground for getBoundingBox

getClassName Search playground for getClassName

getNumChildren Search playground for getNumChildren

removeChild Search playground for removeChild

Static FromMesh Search playground for FromMesh