PhysicsShapeCylinder | Babylon.js API documentation

Class PhysicsShapeCylinder

Helper object to create a cylinder shape

Hierarchy (View Summary)

PhysicsShape
- PhysicsShapeCylinder

Index

Constructors

constructor

new PhysicsShapeCylinder(
    pointA: Vector3,
    pointB: Vector3,
    radius: number,
    scene: Scene,
): PhysicsShapeCylinder
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
Overrides PhysicsShape.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27020

Properties

_pluginData

_pluginData: any

V2 Physics plugin private data for single shape

Accessors

density

get density(): number
Returns the density of the physics shape.

Returns number
The density of the physics shape.
Inherited from PhysicsShape.density
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26930
set density(density: number): void
Sets the density of the physics shape.
Parameters
- density: number
  The density of the physics shape.
Returns void
Inherited from PhysicsShape.density
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26925

filterCollideMask

get filterCollideMask(): number
Returns number
Bitmask of categories that this shape should collide with
Inherited from PhysicsShape.filterCollideMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26910
set filterCollideMask(collideMask: number): void
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
Inherited from PhysicsShape.filterCollideMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26905

filterMembershipMask

get filterMembershipMask(): number
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/typedoc/docdirectory/doc.d.ts:26889
set filterMembershipMask(membershipMask: number): void
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
Inherited from PhysicsShape.filterMembershipMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26884

isTrigger

get isTrigger(): boolean
Returns boolean
Inherited from PhysicsShape.isTrigger
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26965
set isTrigger(isTrigger: boolean): void
Parameters
- isTrigger: boolean
Returns void
Inherited from PhysicsShape.isTrigger
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26964

material

get material(): PhysicsMaterial
Returns the material of the physics shape.

Returns PhysicsMaterial
The material of the physics shape.
Inherited from PhysicsShape.material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26920
set material(material: PhysicsMaterial): void
Parameters
- material: PhysicsMaterial
Returns void
Inherited from PhysicsShape.material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26915

type

get type(): PhysicsShapeType
Returns the type of the physics shape.

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

Methods

addChild

addChild(
    newChild: PhysicsShape,
    translation?: Vector3,
    rotation?: Quaternion,
    scale?: Vector3,
): void
Adds a child shape to a container with an optional transform
Parameters
- newChild: PhysicsShape
  The new PhysicsShape to add
- Optionaltranslation: Vector3
  Optional position of the child shape relative to this shape
- Optionalrotation: Quaternion
  Optional rotation of the child shape relative to this shape
- Optionalscale: Vector3
  Optional scale of the child shape relative to this shape
Returns void
Inherited from PhysicsShape.addChild
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26948

addChildFromParent

addChildFromParent(
    parentTransform: TransformNode,
    newChild: PhysicsShape,
    childTransform: TransformNode,
): void
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
Inherited from PhysicsShape.addChildFromParent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26940

dispose

dispose(): void
Dispose the shape and release its associated resources.

Returns void
Inherited from PhysicsShape.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26969

getBoundingBox

getBoundingBox(): BoundingBox
Returns the bounding box of the physics shape.

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

getClassName

getClassName(): string
Returns the string "PhysicsShape".

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

getNumChildren

getNumChildren(): number
Returns the number of children of a physics shape.

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

removeChild

removeChild(childIndex: number): void
Removes a child shape from this shape.
Parameters
- childIndex: number
  The index of the child shape to remove
Returns void
Inherited from PhysicsShape.removeChild
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26953

`Static`FromMesh

FromMesh(mesh: AbstractMesh): PhysicsShapeCylinder
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
Physics Shape Cylinder
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27027

Class PhysicsShapeCylinder

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PhysicsShapeCylinder

Properties

_pluginData

Accessors

density

Returns number

Parameters

Returns void

filterCollideMask

Returns number

Parameters

Returns void

filterMembershipMask

Returns number

Parameters

Returns void

isTrigger

Returns boolean

Parameters

Returns void

material

Returns PhysicsMaterial

Parameters

Returns void

type

Returns PhysicsShapeType

Methods

addChild

Parameters

Returns void

addChildFromParent

Parameters

Returns void

dispose

Returns void

getBoundingBox

Returns BoundingBox

getClassName

Returns string

getNumChildren

Returns number

removeChild

Parameters

Returns void

StaticFromMesh

Parameters

Returns PhysicsShapeCylinder

Settings

On This Page

`Static`FromMesh