Class Constraint

Base class for joint constraints, which depends on rigid body components.

Hierarchy

any
- Constraint
  - HingeConstraint
  - PointToPointConstraint

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

newConstraint(type: EConstraintType): Constraint

- Defined in cocos/physics/framework/components/constraints/constraint.ts:124
Parameters
- type: EConstraintType
Returns Constraint

Properties

Readonly TYPE

TYPE: EConstraintType

Gets the type of this joint.

Protected _connectedBody

_connectedBody: RigidBody | null = null

Protected _constraint

_constraint: IBaseConstraint | null = null

Protected _enableCollision

_enableCollision: boolean = true

Static Readonly Type

Type: EnumAlias<typeof EConstraintType> = EConstraintType

Enumeration of joint types.

Accessors

attachedBody

get attachedBody(): RigidBody | null

- Defined in cocos/physics/framework/components/constraints/constraint.ts:67
Gets the collider attached rigid-body.

Returns RigidBody | null

connectedBody

get connectedBody(): RigidBody | null
set connectedBody(v: RigidBody | null): void

- Defined in cocos/physics/framework/components/constraints/constraint.ts:79
Get or set the jointed rigid body, null means link to a static rigid body at the world origin.

Returns RigidBody | null
- Defined in cocos/physics/framework/components/constraints/constraint.ts:83
Get or set the jointed rigid body, null means link to a static rigid body at the world origin.

Parameters
- v: RigidBody | null
Returns void

enableCollision

get enableCollision(): boolean
set enableCollision(v: boolean): void

- Defined in cocos/physics/framework/components/constraints/constraint.ts:97
Get or set whether collision is turned on between two rigid bodies connected by a joint.

Returns boolean
- Defined in cocos/physics/framework/components/constraints/constraint.ts:101
Get or set whether collision is turned on between two rigid bodies connected by a joint.

Parameters
- v: boolean
Returns void

Methods

Protected onDestroy

onDestroy(): void

- Defined in cocos/physics/framework/components/constraints/constraint.ts:152
Returns void

Protected onDisable

onDisable(): void

- Defined in cocos/physics/framework/components/constraints/constraint.ts:146
Returns void

Protected onEnable

onEnable(): void

- Defined in cocos/physics/framework/components/constraints/constraint.ts:140
Returns void

Protected onLoad

onLoad(): void

- Defined in cocos/physics/framework/components/constraints/constraint.ts:133
Returns void

Generated using TypeDoc