API reference
API reference
Select your platform
No SDKs available
No versions available

PanelSceneObject Class

Extends SceneObject
Modifiers: final
PanelSceneObject combines several components to create an interactive 2D surface in 3D space in the following order:
  1. A PanelSurface that holds the pixels of the panel
  2. A PanelDisplay that renders content on the surface
  3. A PanelInputListener that handles input events
  4. A PanelShape that defines the geometry (quad, cylinder, etc.)
Example: Retrieving a PanelSceneObject from an entity using SceneObjectSystem
// Get the SceneObject associated with the entity (returns a CompletableFuture)
systemManager.findSystem<SceneObjectSystem>().getSceneObject(entity)?.thenAccept { sceneObject ->
    if (sceneObject is PanelSceneObject) {
        // Now you can work with the panel
    }
}

Signature

class PanelSceneObject : SceneObject

Constructors

PanelSceneObject ( scene , ctx , intent , ent , config , displayCreator )
Parameters
scene: Scene?
intent: Intent
ent: Entity?
displayCreator: Function4
PanelSceneObject ( scene , ctx , id , ent , config , displayCreator )
Parameters
scene: Scene?
id: Class?
ent: Entity?
displayCreator: Function4
PanelSceneObject ( scene , ctx , ent , config , getView , displayCreator )
Parameters
scene: Scene?
ent: Entity?
getView: Function1
displayCreator: Function4
PanelSceneObject ( scene , ctx , id , ent , config , displayCreator )
Parameters
scene: Scene?
id: Int
ent: Entity?
displayCreator: Function4
PanelSceneObject ( scene , ent , config )
Signature
constructor(scene: Scene?, ent: Entity?, config: PanelConfigOptions = PanelConfigOptions())
Parameters
PanelSceneObject ( scene , ent , opts )
Signature
constructor(scene: Scene?, ent: Entity?, opts: PanelConfigOptions2)
Parameters
PanelSceneObject ( scene , ctx , ent , opts , displayCreator )
Signature
constructor(scene: Scene?, ctx: SpatialContext, ent: Entity?, opts: PanelConfigOptions2, displayCreator: (ctx: SpatialContext, panelSurface: PanelSurface, options: PanelConfigOptions2) -> PanelDisplay = { ctx_, panelSurface_, options_ ->
            val style = options_.style() ?: StyleConfigOptions2()
            val resolution = options_.resolution() ?: ResolutionConfigOptions2()
            val layout = options_.get(LayoutOptions::class.java)!!
            when (layout) {
              is ContentViewConfigOptions2 ->
                  PanelDisplay(
                      ctx_,
                      panelSurface_,
                      resolution.dpi,
                      getView = (layout as ContentViewConfigOptions2).getView(),
                      themeResourceId = style.themeResourceId,
                  )
              is ActivityConfigOptions2 ->
                  PanelDisplay(
                      ctx_,
                      panelSurface_,
                      resolution.dpi,
                      intent = ((layout as ActivityConfigOptions2).getIntent())(ctx_))
              else ->
                  throw IllegalArgumentException(
                      "Missing panel layout config options, use activity or contentView API to setup the panel layout.")
            }
          })
Parameters
scene: Scene?
ent: Entity?
displayCreator: Function3

Properties

entity : Entity?
[Get]
Signature
val entity: Entity?
handle : Long
[Get]
Signature
var handle: Long
materials : Array?
[Get]
Array of SceneMaterials created from this SceneObject's mesh property. Changes to the materials in this array will be unique to this SceneObject, but these materials will inhererit any changes made in the SceneMesh they come from.
Signature
var materials: Array<SceneMaterial>?
mesh : SceneMesh?
[Get][Set]
Reference to the SceneMesh used by this SceneObject. This property is a reference to the underlying mesh resource. Changes to the SceneMesh or its SceneMaterials will be reflected across all SceneObjects that reference it.
Signature
var mesh: SceneMesh?
[Get][Set]
Signature
var options: PanelConfigOptions2
rootView : View?
[Get]
Gets the root View of the panel's display.
Signature
val rootView: View
shapeType : PanelShapeType
[Get]
Signature
val PanelSceneObject.shapeType: PanelShapeType

Methods

addInputListener ( listener )
Add an input listener to this SceneObject.
Signature
fun addInputListener(listener: InputListener): Long
Parameters
listener: InputListener  The input listener to add.
Returns
Long  The id of the input listener.
attachDisplay ( ctxt , clickButtons , displayCreator )
Signature
fun attachDisplay(ctxt: SpatialContext, clickButtons: Int, displayCreator: (PanelSurface) -> PanelDisplay)
Parameters
clickButtons: Int
displayCreator: Function1
createIsdkComponents ( entity )
Signature
fun PanelSceneObject.createIsdkComponents(entity: Entity)
Parameters
entity: Entity
destroy ()
Destory this SceneObject.
Signature
fun destroy()
destroyInternal ()
Destroy this SceneObject's native components.
Signature
open override fun destroyInternal()
detachDisplay ()
Signature
fun detachDisplay()
getDisplay ()
Gets the PanelDisplay associated with this panel.
Signature
fun getDisplay(): PanelDisplay
Returns
PanelDisplay  The PanelDisplay object
getLayer ()
Gets the layer used by this panel.
Signature
fun getLayer(): SceneLayer?
Returns
SceneLayer?  The SceneLayer object or null if no layer is used
getPanelConfigOptions2 ()
Signature
fun getPanelConfigOptions2(): PanelConfigOptions2
getPanelShapeConfig ()
Gets the config used used to create this panel.
Signature
fun getPanelShapeConfig(): PanelShapeConfig?
Returns
PanelShapeConfig?  The PanelShapeConfig object or null if it was not used.
getSurface ()
Gets the PanelSurface associated with this panel.
Signature
fun getSurface(): Surface
Returns
Surface  The PanelSurface object
getSwapchain ()
Gets the SceneSwapchain associated with this panel.
Signature
fun getSwapchain(): SceneSwapchain?
Returns
SceneSwapchain?  The SceneSwapchain object or null if Layers is not enabled.
getTexture ()
Gets the texture used by this panel.
Signature
fun getTexture(): SceneTexture?
Returns
SceneTexture?  The SceneTexture object or null if no texture is used
onClick ( hitInfo , sourceOfInput )
Handler for clicks on this SceneObject.
Signature
open fun onClick(hitInfo: HitInfo, sourceOfInput: Entity)
Parameters
hitInfo: HitInfo  The HitInfo object containing information about the hit.
sourceOfInput: Entity  The entity that generated the pointer event.
onClickDown ( hitInfo , sourceOfInput )
Handler for click downs on this SceneObject. Use onClick() to ensure user releases the click on the SceneObject.
Signature
fun onClickDown(hitInfo: HitInfo, sourceOfInput: Entity)
Parameters
hitInfo: HitInfo  The information related to the hit against the SceneObject.
sourceOfInput: Entity  The entity that was hit.
onHoverStart ( sourceOfInput )
Handler for the start of hovers on this SceneObject.
Signature
open fun onHoverStart(sourceOfInput: Entity)
Parameters
sourceOfInput: Entity  The entity that generated the pointer event.
onHoverStop ( sourceOfInput )
Handler for the termination of hovers on this SceneObject.
Signature
open fun onHoverStop(sourceOfInput: Entity)
Parameters
sourceOfInput: Entity  The entity that generated the pointer event.
onInput ( hitInfo , sourceOfInput , changed , buttonState , downTime )
Handler to handle generic input.
Signature
open fun onInput(hitInfo: HitInfo, sourceOfInput: Entity, changed: Int, buttonState: Int, downTime: Long): Boolean
Parameters
hitInfo: HitInfo  The HitInfo object containing information about the hit.
sourceOfInput: Entity  The entity that generated the pointer event.
changed: Int  A bit mask of changed button state.
buttonState: Int  A bit mask of button state.
downTime: Long  The timestamp when the input interaction began (initial button change)
Returns
Boolean  Whether the input was handled.
onPointerEvent ( hitInfo , type , sourceOfInput , scrollInfo , semanticType )
Handler to handle pointer events on this SceneObject.
Signature
open fun onPointerEvent(hitInfo: HitInfo, type: Int, sourceOfInput: Entity, scrollInfo: Vector2, semanticType: Int = SemanticType.Unknown.id)
Parameters
hitInfo: HitInfo  The HitInfo object containing information about the hit.
type: Int  The type of pointer event.
sourceOfInput: Entity  The entity that generated the pointer event.
scrollInfo: Vector2  Scroll speeds in the x and y directions.
semanticType: Int  The semantic type (e.g. select, grab, etc).
removeInputListener ( id )
Remove an input listener by id.
Signature
fun removeInputListener(id: Long)
Parameters
id: Long  The id of the input listnener to remove.
reshape ( shapeConfig )
Destroy and recreate the PanelShape with the given config.
Signature
fun reshape(shapeConfig: PanelShapeConfig)
Parameters
shapeConfig: PanelShapeConfig  The new PanelShapeConfig.
reshape ( options )
Signature
fun reshape(options: PanelConfigOptions2)
Parameters
setIsVisible ( isVisible )
Set whether this SceneObject is visible.
Signature
fun setIsVisible(isVisible: Boolean)
Parameters
isVisible: Boolean  Whether or not this SceneObjet is visible.
setLocalNodePose ( node , pose )
Sets the local transform of the node (relative to it's parent) to the input pose
Signature
fun setLocalNodePose(node: Int, pose: Pose)
Parameters
node: Int  : The node id.
pose: Pose  : The pose.
setPosition ( position )
Set the 3D position of this SceneObject.
Signature
fun setPosition(position: Vector3)
Parameters
position: Vector3  The position as a Vector3 object.
setPosition ( x , y , z )
Set the 3D position of this SceneObject.
Signature
fun setPosition(x: Float, y: Float, z: Float)
Parameters
x: Float  The x coordinate of the position.
y: Float  The y coordinate of the position.
z: Float  The z coordinate of the position.
setRotation ( pitch , yaw , roll )
Set the rotation of this SceneObject.
Signature
fun setRotation(pitch: Float, yaw: Float, roll: Float)
Parameters
pitch: Float  The pitch of the rotation in degrees.
yaw: Float  The yaw of the rotation in degrees.
roll: Float  The roll of the rotation in degrees.
setRotationQuat ( quat )
Set the rotation of this SceneObject.
Signature
fun setRotationQuat(quat: Quaternion)
Parameters
quat: Quaternion  The quaternion representing the rotation.
setRotationQuat ( x , y , z , w )
Set the rotation of this SceneObject.
Signature
fun setRotationQuat(x: Float, y: Float, z: Float, w: Float)
Parameters
x: Float  The x component of the quaternion
y: Float  The y component of the quaternion
z: Float  The z component of the quaternion
w: Float  The w component of the quaternion
setScale ( scale )
Set the scale of the model. The default value is 1.0f.
Signature
open override fun setScale(scale: Vector3)
Parameters
scale: Vector3  The scale represented by a Vector3 object.
setSceneMesh ( mesh , name )
Set the SceneMesh for this SceneObject.
Signature
open fun setSceneMesh(mesh: SceneMesh, name: String)
Parameters
mesh: SceneMesh  The scene mesh to set on this SceneObject.
name: String  The name to set on the entity.
shouldFrustumCull ( cull )
Whether this SceneObject can be frustum culled (default is true)
Signature
fun shouldFrustumCull(cull: Boolean)
Parameters
cull: Boolean  Whether or not this SceneObject can be frustum called.
stopInput ( sourceOfInput , downTime )
This function calls the stopInput function on all InputListener for this SceneObject. This is called automatically by Scene when handling inputs.
Signature
open fun stopInput(sourceOfInput: Entity, downTime: Long)
Parameters
sourceOfInput: Entity  The controller Entity that triggered the input
downTime: Long  The timestamp when the input interaction began (initial button change)
updateAnimationTrackToTime ( track , timeInSeconds )
Update the local transforms of the model to match the given animation track at the specified time (matching keyframe time in the glTF).
Track can be found from SceneMesh.getAnimationTracks
Signature
fun updateAnimationTrackToTime(track: Int, timeInSeconds: Float)
Parameters
track: Int  The track id.
timeInSeconds: Float  The time in seconds.
updateIsdkComponentProperties ( entity )
Signature
fun PanelSceneObject.updateIsdkComponentProperties(entity: Entity)
Parameters
entity: Entity
updateNodeLocalPoseToObjectPose ( node , pose )
Sets the local transform of a node (relative to it's parent) such that the resulting object transform (relative to the model) is placed at the input pose
WARNING: This may be an expensive operation as it recalculates object positions
Signature
fun updateNodeLocalPoseToObjectPose(node: Int, pose: Pose)
Parameters
node: Int  : The node id.
pose: Pose  : The pose.
updateSceneMesh ( meshModifier )
Modify and update this SceneObject's mesh.
Signature
fun updateSceneMesh(meshModifier: SceneMesh.() -> Unit)
Parameters
meshModifier: Function1  The mesh modifier to apply to this SceneObject's mesh.