Class Blueprint

Represents an entire blueprint file.

Hierarchy

Blueprint

Index

Constructors

Properties

Methods

addBody addJoint getBodies getJointFromId getJoints removeBody removeJoint toJSON writeToFile create fromFile fromJson

Constructors

constructor

new Blueprint(fileBlueprint?: FileBlueprint): Blueprint
Parameters
- Optional fileBlueprint: FileBlueprint
Returns Blueprint
- Defined in class/blueprint.ts:1574

Properties

`Private` `Readonly` fileBlueprint

fileBlueprint: FileBlueprint

Methods

addBody

addBody(body?: Body): Body
Adds a body to the blueprint.

Returns
The added body.
Parameters
- Optional body: Body
  
  The body to add.
Returns Body
- Defined in class/blueprint.ts:1686

addJoint

addJoint<T>(joint: T): T
Adds a joint to the blueprint.

Returns
The added joint.
Type Parameters
Type Parameters
- T extends Joint<T>
Parameters
- joint: T
  
  The joint to add.
Returns T
- Defined in class/blueprint.ts:1666

getBodies

getBodies(): Body[]
Gets a list of all the bodies in the blueprint.

Returns
The list of bodies.

Returns Body[]
- Defined in class/blueprint.ts:1608

getJointFromId

getJointFromId(id: number): undefined | Joint
Gets a joint in the blueprint with the given ID if it exists.

Returns
The joint, if it exists.
Parameters
- id: number
  
  The ID of the joint.
Returns undefined | Joint
- Defined in class/blueprint.ts:1705

getJoints

getJoints(): Joint[]
Gets a list of all the joints in the blueprint.

Returns
The list of joints.

Returns Joint[]
- Defined in class/blueprint.ts:1615

removeBody

removeBody(body: Body): void
Removes a body from the blueprint, if it is present.
Parameters
- body: Body
  
  The body to remove.
Returns void
- Defined in class/blueprint.ts:1695

removeJoint

removeJoint(joint: Joint): void
Removes a joint from the blueprint, if it is present.
Parameters
- joint: Joint
  
  The joint to remove.
Returns void
- Defined in class/blueprint.ts:1675

toJSON

toJSON(): string
Converts the blueprint to a JSON string.

Returns
The JSON string.

Returns string
- Defined in class/blueprint.ts:1632

writeToFile

writeToFile(path: PathOrFileDescriptor): void
Converts the blueprint to a JSON string and writes it to a file.
Parameters
- path: PathOrFileDescriptor
  
  The file path.
Returns void
- Defined in class/blueprint.ts:1658

`Static` create

create(): Blueprint
Creates a blank blueprint.

Returns
The created blueprint.

Returns Blueprint
- Defined in class/blueprint.ts:1584

`Static` fromFile

fromFile(path: PathOrFileDescriptor): Blueprint
Creates a blueprint from a file path.

Returns
The created blueprint.
Parameters
- path: PathOrFileDescriptor
  
  The file path.
Returns Blueprint
- Defined in class/blueprint.ts:1600

`Static` fromJson

fromJson(text: string): Blueprint
Creates a blueprint from a JSON string.

Returns
The created blueprint.
Parameters
- text: string
  
  The JSON string.
Returns Blueprint
- Defined in class/blueprint.ts:1592

Generated using TypeDoc