Documentation
¶
Overview ¶
This node uses body tracking data from an XRBodyTracker to pose the skeleton of a body mesh.
Positioning of the body is performed by creating an XRNode3D ancestor of the body mesh driven by the same XRBodyTracker.
The body tracking position-data is scaled by Skeleton3D.MotionScale when applied to the skeleton, which can be used to adjust the tracked body to match the scale of the body model.
Index ¶
- type Advanced
- type Any
- type BodyUpdate
- type BoneUpdate
- type Extension
- type ID
- type Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsSkeletonModifier3D() SkeletonModifier3D.Instance
- func (self Instance) AsXRBodyModifier3D() Instance
- func (self Instance) BodyTracker() string
- func (self Instance) BodyUpdate() BodyUpdate
- func (self Instance) BoneUpdate() BoneUpdate
- func (self Instance) ID() ID
- func (self Instance) SetBodyTracker(value string)
- func (self Instance) SetBodyUpdate(value BodyUpdate)
- func (self Instance) SetBoneUpdate(value BoneUpdate)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type BodyUpdate ¶
type BodyUpdate int //gd:XRBodyModifier3D.BodyUpdate
const ( // The skeleton's upper body joints are updated. BodyUpdateUpperBody BodyUpdate = 1 // The skeleton's lower body joints are updated. BodyUpdateLowerBody BodyUpdate = 2 // The skeleton's hand joints are updated. BodyUpdateHands BodyUpdate = 4 )
type BoneUpdate ¶
type BoneUpdate int //gd:XRBodyModifier3D.BoneUpdate
const ( // The skeleton's bones are fully updated (both position and rotation) to match the tracked bones. BoneUpdateFull BoneUpdate = 0 // The skeleton's bones are only rotated to align with the tracked bones, preserving bone length. BoneUpdateRotationOnly BoneUpdate = 1 // Represents the size of the [BoneUpdate] enum. BoneUpdateMax BoneUpdate = 2 )
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsSkeletonModifier3D ¶
func (self *Extension[T]) AsSkeletonModifier3D() SkeletonModifier3D.Instance
func (*Extension[T]) AsXRBodyModifier3D ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.XRBodyModifier3D
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsSkeletonModifier3D ¶
func (self Instance) AsSkeletonModifier3D() SkeletonModifier3D.Instance
func (Instance) AsXRBodyModifier3D ¶
func (Instance) BodyTracker ¶
The name of the XRBodyTracker registered with XRServer to obtain the body tracking data from.
func (Instance) BodyUpdate ¶
func (self Instance) BodyUpdate() BodyUpdate
Specifies the body parts to update.
func (Instance) BoneUpdate ¶
func (self Instance) BoneUpdate() BoneUpdate
Specifies the type of updates to perform on the bones.
func (Instance) SetBodyTracker ¶
SetBodyTracker sets the property returned by [GetBodyTracker].
func (Instance) SetBodyUpdate ¶
func (self Instance) SetBodyUpdate(value BodyUpdate)
SetBodyUpdate sets the property returned by [GetBodyUpdate].
func (Instance) SetBoneUpdate ¶
func (self Instance) SetBoneUpdate(value BoneUpdate)
SetBoneUpdate sets the property returned by [GetBoneUpdate].
Source Files