Class JointSpherical

A physical connection between two bodies with three Degrees of Freedom, also known as ball and socket joint. Two bodies connected at their anchor but free to rotate. Used for things like the connection of bones in the human shoulder (if simplified, else better use JointRagdoll). Two RigidBodies need to be defined to use it. Only spring settings can be defined. 3 Degrees are swing horizontal, swing vertical and twist.

             JointHolder
        z      bodyAnchor (e.g. Human-Shoulder)     
     y  ↑          
       \|          ───(●───
 -x <---|---> x           bodyTied        
        |\                (e.g. Upper-Arm) 
        ↓ -y       
       -z

Author

Marko Fehrenbach, HFU, 2020 | Jirka Dell'Oro-Friedl, HFU, 2021

Hierarchy (view full)

Joint
- JointSpherical

Constructors

constructor

new JointSpherical(_bodyAnchor?, _bodyTied?, _localAnchor?): JointSpherical
Parameters
- _bodyAnchor: ComponentRigidbody = null
- _bodyTied: ComponentRigidbody = null
- _localAnchor: Vector3 = ...
Returns JointSpherical
Overrides Joint.constructor
- Defined in Source/Core/Physics/JointSpherical.ts:29

Properties

`Static` `Readonly` baseClass

baseClass: typeof Joint = Joint

refers back to this class from any subclass e.g. in order to find compatible other resources

`Static` `Readonly` iSubclass

iSubclass: number = ...

subclasses get a iSubclass number for identification

`Static` `Readonly` subclasses

subclasses: typeof Joint[] = []

list of all the subclasses derived from this class, if they registered properly

Accessors

anchor

get anchor(): Vector3
The exact position where the two Nodes are connected. When changed after initialization the joint needs to be reconnected.

Returns Vector3
Inherited from Joint.anchor
- Defined in Source/Core/Physics/Joint.ts:79
set anchor(_value): void
Parameters
- _value: Vector3
Returns void
Inherited from Joint.anchor
- Defined in Source/Core/Physics/Joint.ts:82

bodyAnchor

get bodyAnchor(): ComponentRigidbody
Get/Set the first ComponentRigidbody of this connection. It should always be the one that this component is attached too in the sceneTree.

Returns ComponentRigidbody
Inherited from Joint.bodyAnchor
- Defined in Source/Core/Physics/Joint.ts:54
set bodyAnchor(_cmpRB): void
Parameters
- _cmpRB: ComponentRigidbody
Returns void
Inherited from Joint.bodyAnchor
- Defined in Source/Core/Physics/Joint.ts:58

bodyTied

get bodyTied(): ComponentRigidbody
Get/Set the second ComponentRigidbody of this connection.

Returns ComponentRigidbody
Inherited from Joint.bodyTied
- Defined in Source/Core/Physics/Joint.ts:66
set bodyTied(_cmpRB): void
Parameters
- _cmpRB: ComponentRigidbody
Returns void
Inherited from Joint.bodyTied
- Defined in Source/Core/Physics/Joint.ts:69

breakForce

get breakForce(): number
The amount of force needed to break the JOINT, in Newton. 0 equals unbreakable (default)

Returns number
Inherited from Joint.breakForce
- Defined in Source/Core/Physics/Joint.ts:102
set breakForce(_value): void
Parameters
- _value: number
Returns void
Inherited from Joint.breakForce
- Defined in Source/Core/Physics/Joint.ts:105

breakTorque

get breakTorque(): number
The amount of force needed to break the JOINT, while rotating, in Newton. 0 equals unbreakable (default)

Returns number
Inherited from Joint.breakTorque
- Defined in Source/Core/Physics/Joint.ts:91
set breakTorque(_value): void
Parameters
- _value: number
Returns void
Inherited from Joint.breakTorque
- Defined in Source/Core/Physics/Joint.ts:94

internalCollision

get internalCollision(): boolean
If the two connected RigidBodies collide with eath other. (Default = false) On a welding joint the connected bodies should not be colliding with each other, for best results

Returns boolean
Inherited from Joint.internalCollision
- Defined in Source/Core/Physics/Joint.ts:115
set internalCollision(_value): void
Parameters
- _value: boolean
Returns void
Inherited from Joint.internalCollision
- Defined in Source/Core/Physics/Joint.ts:118

isActive

get isActive(): boolean
Returns boolean
Inherited from Joint.isActive
- Defined in Source/Core/Component/Component.ts:36

isSingleton

get isSingleton(): boolean
Is true, when only one instance of the component class can be attached to a node

Returns boolean
Inherited from Joint.isSingleton
- Defined in Source/Core/Component/Component.ts:43

node

get node(): Node
Retrieves the node, this component is currently attached to

Returns Node
Inherited from Joint.node
- Defined in Source/Core/Component/Component.ts:50

springDamping

get springDamping(): number
The damping of the spring. 1 equals completly damped.

Returns number
- Defined in Source/Core/Physics/JointSpherical.ts:39
set springDamping(_value): void
Parameters
- _value: number
Returns void
- Defined in Source/Core/Physics/JointSpherical.ts:42

springFrequency

get springFrequency(): number
The frequency of the spring in Hz. At 0 the spring is rigid, equals no spring. The smaller the value the less restrictive is the spring.

Returns number
- Defined in Source/Core/Physics/JointSpherical.ts:50
set springFrequency(_value): void
Parameters
- _value: number
Returns void
- Defined in Source/Core/Physics/JointSpherical.ts:53

type

get type(): string
Retrieves the type of this mutable subclass as the name of the runtime class

Returns string
The type of the mutable
Inherited from Joint.type
- Defined in Source/Core/Serialization/Mutable.ts:175

Methods

activate

activate(_on): void
De- / Activate this component. Inactive components will not be processed by the renderer.
Parameters
- _on: boolean
Returns void
Inherited from Joint.activate
- Defined in Source/Core/Component/Component.ts:57

addEventListener

addEventListener(_type, _handler, _options?): void
See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from Joint.addEventListener
- Defined in Source/Core/Event/Event.ts:91

attachToNode

attachToNode(_container): void
Tries to attach the component to the given node, removing it from the node it was attached to if applicable
Parameters
- _container: Node
Returns void
Inherited from Joint.attachToNode
- Defined in Source/Core/Component/Component.ts:65

connect

connect(): void
Initializing and connecting the two rigidbodies with the configured joint properties is automatically called by the physics system. No user interaction needed.

Returns void
Inherited from Joint.connect
- Defined in Source/Core/Physics/Joint.ts:168

connectChild

connectChild(_name): void
Connect a child node with the given name to the joint.
Parameters
- _name: string
Returns void
Inherited from Joint.connectChild
- Defined in Source/Core/Physics/Joint.ts:126

connectNode

connectNode(_node): void
Connect the given node to the joint. Tieing its rigidbody to the nodes rigidbody this component is attached to.
Parameters
- _node: Node
Returns void
Inherited from Joint.connectNode
- Defined in Source/Core/Physics/Joint.ts:141

deserialize

deserialize(_serialization): Promise<Serializable>
Recreates this instance of Serializable with the information from the given Serialization.
Parameters
- _serialization: Serialization
Returns Promise<Serializable>
Overrides Joint.deserialize
- Defined in Source/Core/Physics/JointSpherical.ts:69

disconnect

disconnect(): void
Disconnecting the two rigidbodies and removing them from the physics system, is automatically called by the physics system. No user interaction needed.

Returns void
Inherited from Joint.disconnect
- Defined in Source/Core/Physics/Joint.ts:186

dispatchEvent

dispatchEvent(_event): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from Joint.dispatchEvent
- Defined in Source/Core/Event/Event.ts:105

`Optional` drawGizmos

drawGizmos(_cmpCamera?): void
Override this to draw visual aids for this component inside the editors render view. Use Gizmos inside the override to draw stuff.
Parameters
- Optional _cmpCamera: ComponentCamera
Returns void
Inherited from Joint.drawGizmos
- Defined in Source/Core/Component/Component.ts:83

`Optional` drawGizmosSelected

drawGizmosSelected(_cmpCamera?): void
See drawGizmos. Only displayed while the corresponding node is selected.
Parameters
- Optional _cmpCamera: ComponentCamera
Returns void
Inherited from Joint.drawGizmosSelected
- Defined in Source/Core/Component/Component.ts:88

getMetaAttributeTypes

getMetaAttributeTypes(): MetaAttributeTypes
Retrieves the specified attribute types from the metadata of this instance's class.

Returns MetaAttributeTypes
Inherited from Joint.getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:265

getMetadata

getMetadata(): Metadata
Retrieves the metadata of this instance's class.

Returns Metadata
Inherited from Joint.getMetadata
- Defined in Source/Core/Serialization/Mutable.ts:272

getMutator

getMutator(): Mutator
Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.

Returns Mutator
Overrides Joint.getMutator
- Defined in Source/Core/Physics/JointSpherical.ts:76

getMutatorAttributeTypes

getMutatorAttributeTypes(_mutator): MutatorAttributeTypes
Returns an associative array with the same attributes as the given mutator, but with the corresponding types as string-values. Does not recurse into objects! This will return the decorated meta-type instead of the runtime-type of the object, if available.
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from Joint.getMutatorAttributeTypes
- Defined in Source/Core/Physics/Joint.ts:223

getMutatorForAnimation

getMutatorForAnimation(_extendable?): MutatorForAnimation
Collect the attributes of the instance and their values applicable for animation. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForAnimation
Inherited from Joint.getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:219

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?): MutatorForUserInterface
Collect the attributes of the instance and their values applicable for the user interface. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForUserInterface
Inherited from Joint.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:227

getOimoJoint

getOimoJoint(): Joint
Returns the original Joint used by the physics engine. Used internally no user interaction needed. Only to be used when functionality that is not added within FUDGE is needed.

Returns Joint
Inherited from Joint.getOimoJoint
- Defined in Source/Core/Physics/Joint.ts:197

isConnected

isConnected(): boolean
Check if connection is dirty, so when either rb is changed disconnect and reconnect. Internally used no user interaction needed.

Returns boolean
Inherited from Joint.isConnected
- Defined in Source/Core/Physics/Joint.ts:160

mutate

mutate(_mutator, _selection?, _dispatchMutate?): Promise<void>
Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses
Parameters
- _mutator: Mutator
- _selection: string[] = null
- _dispatchMutate: boolean = true
Returns Promise<void>
Overrides Joint.mutate
- Defined in Source/Core/Physics/JointSpherical.ts:83

removeEventListener

removeEventListener(_type, _handler, _options?): void
See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from Joint.removeEventListener
- Defined in Source/Core/Event/Event.ts:98

serialize

serialize(): Serialization
Returns a Serialization of this object.

Returns Serialization
Overrides Joint.serialize
- Defined in Source/Core/Physics/JointSpherical.ts:60

updateMutator

updateMutator(_mutator): void
Updates the values of the given mutator according to the current state of the instance
Parameters
- _mutator: Mutator
Returns void
Inherited from Joint.updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:280

`Static` getMutatorFromPath

getMutatorFromPath(_mutator, _path): Mutator
Decorator allows to attach Mutable functionality to existing classes.
Parameters
- _mutator: Mutator
- _path: string[]
Returns Mutator
Inherited from Joint.getMutatorFromPath
- Defined in Source/Core/Serialization/Mutable.ts:160

Class JointSpherical

Author

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns JointSpherical

Properties

Static Readonly baseClass

Static Readonly iSubclass

Static Readonly subclasses

Accessors

anchor

Returns Vector3

Parameters

Returns void

bodyAnchor

Returns ComponentRigidbody

Parameters

Returns void

bodyTied

Returns ComponentRigidbody

Parameters

Returns void

breakForce

Returns number

Parameters

Returns void

breakTorque

Returns number

Parameters

Returns void

internalCollision

Returns boolean

Parameters

Returns void

isActive

Returns boolean

isSingleton

Returns boolean

node

Returns Node

springDamping

Returns number

Parameters

Returns void

springFrequency

Returns number

Parameters

Returns void

type

Returns string

Methods

activate

Parameters

Returns void

addEventListener

Parameters

Returns void

attachToNode

Parameters

Returns void

connect

Returns void

connectChild

Parameters

Returns void

connectNode

Parameters

Returns void

deserialize

Parameters

Returns Promise<Serializable>

disconnect

Returns void

`Static` `Readonly` baseClass

`Static` `Readonly` iSubclass

`Static` `Readonly` subclasses

`Optional` drawGizmos

`Optional` drawGizmosSelected

`Static` getMutatorFromPath