Documentation
¶
Overview ¶
This class implements the OpenXR Render Model Extension, if enabled it will maintain a list of active render models and provides an interface to the render model data.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsOpenXRExtensionWrapper() OpenXRExtensionWrapper.Instance
- func (self Instance) AsOpenXRRenderModelExtension() Instance
- func (self Instance) ID() ID
- func (self Instance) IsActive() bool
- func (self Instance) OnRenderModelAdded(cb func(render_model RID.Any), flags ...Signal.Flags)
- func (self Instance) OnRenderModelRemoved(cb func(render_model RID.Any), flags ...Signal.Flags)
- func (self Instance) OnRenderModelTopLevelPathChanged(cb func(render_model RID.Any), flags ...Signal.Flags)
- func (self Instance) RenderModelCreate(render_model_id int) RID.RenderModel
- func (self Instance) RenderModelDestroy(render_model RID.RenderModel)
- func (self Instance) RenderModelGetAll() []RID.RenderModel
- func (self Instance) RenderModelGetAnimatableNodeCount(render_model RID.RenderModel) int
- func (self Instance) RenderModelGetAnimatableNodeName(render_model RID.RenderModel, index int) string
- func (self Instance) RenderModelGetAnimatableNodeTransform(render_model RID.RenderModel, index int) Transform3D.BasisOrigin
- func (self Instance) RenderModelGetConfidence(render_model RID.RenderModel) XRPose.TrackingConfidence
- func (self Instance) RenderModelGetRootTransform(render_model RID.RenderModel) Transform3D.BasisOrigin
- func (self Instance) RenderModelGetSubactionPaths(render_model RID.RenderModel) []string
- func (self Instance) RenderModelGetTopLevelPath(render_model RID.RenderModel) string
- func (self Instance) RenderModelIsAnimatableNodeVisible(render_model RID.RenderModel, index int) bool
- func (self Instance) RenderModelNewSceneInstance(render_model RID.RenderModel) Node3D.Instance
- 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 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]) AsOpenXRExtensionWrapper ¶
func (self *Extension[T]) AsOpenXRExtensionWrapper() OpenXRExtensionWrapper.Instance
func (*Extension[T]) AsOpenXRRenderModelExtension ¶
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.OpenXRRenderModelExtension
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) AsOpenXRExtensionWrapper ¶
func (self Instance) AsOpenXRExtensionWrapper() OpenXRExtensionWrapper.Instance
func (Instance) AsOpenXRRenderModelExtension ¶
func (Instance) IsActive ¶
Returns true if OpenXR's render model extension is supported and enabled.
Note: This only returns a valid value after OpenXR has been initialized.
func (Instance) OnRenderModelAdded ¶
func (Instance) OnRenderModelRemoved ¶
func (Instance) OnRenderModelTopLevelPathChanged ¶
func (Instance) RenderModelCreate ¶
func (self Instance) RenderModelCreate(render_model_id int) RID.RenderModel
Creates a render model object within OpenXR using a render model id.
Note: This function is exposed for dependent OpenXR extensions that provide render model ids to be used with the render model extension.
func (Instance) RenderModelDestroy ¶
func (self Instance) RenderModelDestroy(render_model RID.RenderModel)
Destroys a render model object within OpenXR that was previously created with Instance.RenderModelCreate.
Note: This function is exposed for dependent OpenXR extensions that provide render model ids to be used with the render model extension.
func (Instance) RenderModelGetAll ¶
func (self Instance) RenderModelGetAll() []RID.RenderModel
Returns an array of all currently active render models registered with this extension.
func (Instance) RenderModelGetAnimatableNodeCount ¶
func (self Instance) RenderModelGetAnimatableNodeCount(render_model RID.RenderModel) int
Returns the number of animatable nodes this render model has.
func (Instance) RenderModelGetAnimatableNodeName ¶
func (self Instance) RenderModelGetAnimatableNodeName(render_model RID.RenderModel, index int) string
Returns the name of the given animatable node.
func (Instance) RenderModelGetAnimatableNodeTransform ¶
func (self Instance) RenderModelGetAnimatableNodeTransform(render_model RID.RenderModel, index int) Transform3D.BasisOrigin
Returns the current local transform for an animatable node. This is updated every frame.
func (Instance) RenderModelGetConfidence ¶
func (self Instance) RenderModelGetConfidence(render_model RID.RenderModel) XRPose.TrackingConfidence
Returns the tracking confidence of the tracking data for the render model.
func (Instance) RenderModelGetRootTransform ¶
func (self Instance) RenderModelGetRootTransform(render_model RID.RenderModel) Transform3D.BasisOrigin
Returns the root transform of a render model. This is the tracked position relative to our graphics.gd/classdb/XROrigin3D node.
func (Instance) RenderModelGetSubactionPaths ¶
func (self Instance) RenderModelGetSubactionPaths(render_model RID.RenderModel) []string
Returns a list of active subaction paths for this 'render_model'.
Note: If different devices are bound to your actions than available in suggested interaction bindings, this information shows paths related to the interaction bindings being mimicked by that device.
func (Instance) RenderModelGetTopLevelPath ¶
func (self Instance) RenderModelGetTopLevelPath(render_model RID.RenderModel) string
Returns the top level path associated with this 'render_model'. If provided this identifies whether the render model is associated with the player's hands or other body part.
func (Instance) RenderModelIsAnimatableNodeVisible ¶
func (self Instance) RenderModelIsAnimatableNodeVisible(render_model RID.RenderModel, index int) bool
Returns true if this animatable node should be visible.
func (Instance) RenderModelNewSceneInstance ¶
func (self Instance) RenderModelNewSceneInstance(render_model RID.RenderModel) Node3D.Instance
Returns an instance of a subscene that contains all graphics.gd/classdb/MeshInstance3D nodes that allow you to visualize the render model.