rigidBody property
ComponentDefinition<RigidBody3DComponent>
get
rigidBody
RigidBody3DComponent: grouped, labelled and described as RigidBody2DComponent is.
Implementation
static ComponentDefinition<RigidBody3DComponent>
get rigidBody => ComponentDefinition<RigidBody3DComponent>(
type: 'RigidBody3DComponent',
id: 'rigid_body_3d_d3ff8994',
create: RigidBody3DComponent.new,
hints: ComponentHints(
dimensions: Dimensions.threeD,
name: 'Rigid Body 3D',
group: _group,
description:
'Simulates the entity: gravity, forces and collisions. Its shape is a Collider 3D.',
icon: Icons.sports_basketball,
accentColor: const Color(0xFFFF7043),
fieldGroups: const {
'Body': ['bodyType', 'mass', 'layer', 'isSensor'],
'Surface': ['friction', 'restitution'],
'Motion': [
'gravityScale',
'linearDamping',
'angularDamping',
'continuousCollision',
'canSleep',
'lockRotation',
'initialVelocity',
'initialAngularVelocity',
],
},
fields: {
'bodyType': const FieldHint(
label: 'Body type',
description: PhysicsDefinitions.bodyTypeDescription,
),
'mass': FieldHint(
label: 'Mass',
description:
'How heavy it is, in kg; 0 works it out from the collider.',
scrub: const ScrubHint(step: 0.5, fractionDigits: 1, suffix: 'kg'),
visibleWhen: (c) =>
(c as RigidBody3DComponent).bodyType == Body3DType.dynamic,
),
'layer': const FieldHint(
label: 'Layer',
description: PhysicsDefinitions.layerDescription,
),
'isSensor': const FieldHint(
label: 'Sensor',
description: PhysicsDefinitions.sensorDescription,
),
'friction': FieldHint(
label: 'Friction',
description: PhysicsDefinitions.frictionDescription,
slider: true,
scrub: _plain,
visibleWhen: (c) => !(c as RigidBody3DComponent).isSensor,
),
'restitution': FieldHint(
label: 'Bounciness',
description: PhysicsDefinitions.restitutionDescription,
slider: true,
scrub: _plain,
visibleWhen: (c) => !(c as RigidBody3DComponent).isSensor,
),
'gravityScale': FieldHint(
label: 'Gravity scale',
description: PhysicsDefinitions.gravityScaleDescription,
scrub: const ScrubHint(step: 0.05, fractionDigits: 2, suffix: '×'),
visibleWhen: (c) =>
(c as RigidBody3DComponent).bodyType == Body3DType.dynamic,
),
'linearDamping': FieldHint(
label: 'Linear damping',
description: PhysicsDefinitions.linearDampingDescription,
scrub: const ScrubHint(step: 0.05, fractionDigits: 2, suffix: '/s'),
visibleWhen: (c) =>
(c as RigidBody3DComponent).bodyType == Body3DType.dynamic,
),
'angularDamping': FieldHint(
label: 'Angular damping',
description: 'As linear damping, for its spin.',
scrub: const ScrubHint(step: 0.05, fractionDigits: 2, suffix: '/s'),
visibleWhen: (c) =>
(c as RigidBody3DComponent).bodyType == Body3DType.dynamic,
),
'continuousCollision': FieldHint(
label: 'Continuous',
description: PhysicsDefinitions.continuousDescription,
visibleWhen: (c) =>
(c as RigidBody3DComponent).bodyType == Body3DType.dynamic,
),
'canSleep': FieldHint(
label: 'Can sleep',
description: PhysicsDefinitions.canSleepDescription,
visibleWhen: (c) =>
(c as RigidBody3DComponent).bodyType != Body3DType.static,
),
'lockRotation': FieldHint(
label: 'Lock rotation',
description: PhysicsDefinitions.lockRotationDescription,
visibleWhen: (c) =>
(c as RigidBody3DComponent).bodyType != Body3DType.static,
),
'initialVelocity': FieldHint(
label: 'Start velocity',
description:
'The velocity it starts with, in m/s: a thrown crate, a platform already on its way.',
visibleWhen: (c) =>
(c as RigidBody3DComponent).bodyType != Body3DType.static,
),
'initialAngularVelocity': FieldHint(
label: 'Start spin',
description:
'The spin it starts with, in radians per second about each axis.',
visibleWhen: (c) =>
(c as RigidBody3DComponent).bodyType != Body3DType.static,
),
},
),
fields: [
FieldDefinition(
name: 'bodyType',
kind: _bodyType,
read: (c) => (c as RigidBody3DComponent).bodyType,
write: (c, v) => (c as RigidBody3DComponent).bodyType = v as Body3DType,
),
_decimal<RigidBody3DComponent>(
'mass',
(c) => c.mass,
(c, v) => c.mass = v,
min: 0,
),
FieldDefinition(
name: 'layer',
kind: PhysicsDefinitions.layerType,
read: (c) => (c as RigidBody3DComponent).layer,
write: (c, v) => (c as RigidBody3DComponent).layer = (v as num).toInt(),
),
_bool<RigidBody3DComponent>(
'isSensor',
(c) => c.isSensor,
(c, v) => c.isSensor = v,
),
_decimal<RigidBody3DComponent>(
'friction',
(c) => c.friction,
(c, v) => c.friction = v,
min: 0,
),
_decimal<RigidBody3DComponent>(
'restitution',
(c) => c.restitution,
(c, v) => c.restitution = v,
min: 0,
max: 1,
),
_decimal<RigidBody3DComponent>(
'gravityScale',
(c) => c.gravityScale,
(c, v) => c.gravityScale = v,
),
_decimal<RigidBody3DComponent>(
'linearDamping',
(c) => c.linearDamping,
(c, v) => c.linearDamping = v,
min: 0,
),
_decimal<RigidBody3DComponent>(
'angularDamping',
(c) => c.angularDamping,
(c, v) => c.angularDamping = v,
min: 0,
),
_bool<RigidBody3DComponent>(
'continuousCollision',
(c) => c.continuousCollision,
(c, v) => c.continuousCollision = v,
),
_bool<RigidBody3DComponent>(
'canSleep',
(c) => c.canSleep,
(c, v) => c.canSleep = v,
),
_bool<RigidBody3DComponent>(
'lockRotation',
(c) => c.lockRotation,
(c, v) => c.lockRotation = v,
),
_vector<RigidBody3DComponent>(
'initialVelocity',
(c) => c.initialVelocity,
(c, v) => c.initialVelocity = v,
),
_vector<RigidBody3DComponent>(
'initialAngularVelocity',
(c) => c.initialAngularVelocity,
(c, v) => c.initialAngularVelocity = v,
),
],
);