OpenXRRenderModelExtension
This class implements the OpenXR Render Model Extension.
This class implements the OpenXR Render Model Extension.
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.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
OpenXRRenderModelExtensionConstructor
public OpenXRRenderModelExtension();Methods13
IsActivebool
public bool 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.
boolRenderModelCreateRid
public Rid RenderModelCreate(ulong renderModelId);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.
| Name | Type | Default |
|---|---|---|
renderModelId | ulong | — |
RidRenderModelDestroyvoid
public void RenderModelDestroy(Rid renderModel);Destroys a render model object within OpenXR that was previously created with OpenXRRenderModelExtension.RenderModelCreate.
Note: This function is exposed for dependent OpenXR extensions that provide render model ids to be used with the render model extension.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
RenderModelGetAllReckfell.Collections.Array<Rid>
public Reckfell.Collections.Array<Rid> RenderModelGetAll();Returns an array of all currently active render models registered with this extension.
Reckfell.Collections.Array<Rid>RenderModelGetAnimatableNodeCountuint
public uint RenderModelGetAnimatableNodeCount(Rid renderModel);Returns the number of animatable nodes this render model has.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
uintRenderModelGetAnimatableNodeNamestring
public string RenderModelGetAnimatableNodeName(Rid renderModel, uint index);Returns the name of the given animatable node.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
index | uint | — |
stringRenderModelGetAnimatableNodeTransformTransform3D
public Transform3D RenderModelGetAnimatableNodeTransform(Rid renderModel, uint index);Returns the current local transform for an animatable node. This is updated every frame.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
index | uint | — |
Transform3DRenderModelGetConfidenceXRPose.TrackingConfidenceEnum
public XRPose.TrackingConfidenceEnum RenderModelGetConfidence(Rid renderModel);Returns the tracking confidence of the tracking data for the render model.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
XRPose.TrackingConfidenceEnumRenderModelGetRootTransformTransform3D
public Transform3D RenderModelGetRootTransform(Rid renderModel);Returns the root transform of a render model. This is the tracked position relative to our XROrigin3D node.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
Transform3DRenderModelGetSubactionPathsstring[]
public string[] RenderModelGetSubactionPaths(Rid renderModel);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.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
string[]RenderModelGetTopLevelPathstring
public string RenderModelGetTopLevelPath(Rid renderModel);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.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
stringRenderModelIsAnimatableNodeVisiblebool
public bool RenderModelIsAnimatableNodeVisible(Rid renderModel, uint index);Returns true if this animatable node should be visible.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
index | uint | — |
boolRenderModelNewSceneInstanceEntity3D
public Entity3D RenderModelNewSceneInstance(Rid renderModel);Returns an instance of a subscene that contains all MeshInstance3D nodes that allow you to visualize the render model.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
Entity3DSignals and events3
RenderModelAddedEvent
public event OpenXRRenderModelExtension.RenderModelAddedEventHandler RenderModelAdded;Emitted when a new render model is added.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
RenderModelRemovedEvent
public event OpenXRRenderModelExtension.RenderModelRemovedEventHandler RenderModelRemoved;Emitted when a render model is removed.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |
RenderModelTopLevelPathChangedEvent
public event OpenXRRenderModelExtension.RenderModelTopLevelPathChangedEventHandler RenderModelTopLevelPathChanged;Emitted when the top level path associated with a render model changed.
| Name | Type | Default |
|---|---|---|
renderModel | Rid | — |