reckfellENGINE

OpenXRRenderModelExtension

This class implements the OpenXR Render Model Extension.

On this page
class OpenXRRenderModelExtensionReckfellSharpInherits OpenXRExtensionWrapper

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
# OpenXRRenderModelExtension
C#
public OpenXRRenderModelExtension();

Methods13

IsActivebool
# IsActive
C#
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.

Returns bool
RenderModelCreateRid
# RenderModelCreate
C#
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.

Parameters
NameTypeDefault
renderModelIdulong—
Returns Rid
RenderModelDestroyvoid
# RenderModelDestroy
C#
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.

Parameters
NameTypeDefault
renderModelRid—
RenderModelGetAllReckfell.Collections.Array<Rid>
# RenderModelGetAll
C#
public Reckfell.Collections.Array<Rid> RenderModelGetAll();

Returns an array of all currently active render models registered with this extension.

Returns Reckfell.Collections.Array<Rid>
RenderModelGetAnimatableNodeCountuint
# RenderModelGetAnimatableNodeCount
C#
public uint RenderModelGetAnimatableNodeCount(Rid renderModel);

Returns the number of animatable nodes this render model has.

Parameters
NameTypeDefault
renderModelRid—
Returns uint
RenderModelGetAnimatableNodeNamestring
# RenderModelGetAnimatableNodeName
C#
public string RenderModelGetAnimatableNodeName(Rid renderModel, uint index);

Returns the name of the given animatable node.

Parameters
NameTypeDefault
renderModelRid—
indexuint—
Returns string
RenderModelGetAnimatableNodeTransformTransform3D
# RenderModelGetAnimatableNodeTransform
C#
public Transform3D RenderModelGetAnimatableNodeTransform(Rid renderModel, uint index);

Returns the current local transform for an animatable node. This is updated every frame.

Parameters
NameTypeDefault
renderModelRid—
indexuint—
Returns Transform3D
RenderModelGetConfidenceXRPose.TrackingConfidenceEnum
# RenderModelGetConfidence
C#
public XRPose.TrackingConfidenceEnum RenderModelGetConfidence(Rid renderModel);

Returns the tracking confidence of the tracking data for the render model.

Parameters
NameTypeDefault
renderModelRid—
Returns XRPose.TrackingConfidenceEnum
RenderModelGetRootTransformTransform3D
# RenderModelGetRootTransform
C#
public Transform3D RenderModelGetRootTransform(Rid renderModel);

Returns the root transform of a render model. This is the tracked position relative to our XROrigin3D node.

Parameters
NameTypeDefault
renderModelRid—
Returns Transform3D
RenderModelGetSubactionPathsstring[]
# RenderModelGetSubactionPaths
C#
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.

Parameters
NameTypeDefault
renderModelRid—
Returns string[]
RenderModelGetTopLevelPathstring
# RenderModelGetTopLevelPath
C#
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.

Parameters
NameTypeDefault
renderModelRid—
Returns string
RenderModelIsAnimatableNodeVisiblebool
# RenderModelIsAnimatableNodeVisible
C#
public bool RenderModelIsAnimatableNodeVisible(Rid renderModel, uint index);

Returns true if this animatable node should be visible.

Parameters
NameTypeDefault
renderModelRid—
indexuint—
Returns bool
RenderModelNewSceneInstanceEntity3D
# RenderModelNewSceneInstance
C#
public Entity3D RenderModelNewSceneInstance(Rid renderModel);

Returns an instance of a subscene that contains all MeshInstance3D nodes that allow you to visualize the render model.

Parameters
NameTypeDefault
renderModelRid—
Returns Entity3D

Signals and events3

RenderModelAddedEvent
# RenderModelAdded
C#
public event OpenXRRenderModelExtension.RenderModelAddedEventHandler RenderModelAdded;

Emitted when a new render model is added.

Handler parameters
NameTypeDefault
renderModelRid—
RenderModelRemovedEvent
# RenderModelRemoved
C#
public event OpenXRRenderModelExtension.RenderModelRemovedEventHandler RenderModelRemoved;

Emitted when a render model is removed.

Handler parameters
NameTypeDefault
renderModelRid—
RenderModelTopLevelPathChangedEvent
# RenderModelTopLevelPathChanged
C#
public event OpenXRRenderModelExtension.RenderModelTopLevelPathChangedEventHandler RenderModelTopLevelPathChanged;

Emitted when the top level path associated with a render model changed.

Handler parameters
NameTypeDefault
renderModelRid—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.