Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AvModelProps

Props for AvModel

Hierarchy

Index

Properties

Optional animationSource

animationSource: string

Path of the resource to use as the source for animations in this model. At the moment only /user/hand/left and /user/hand/right are supported for left and right hand skeleton imputs.

default

none

Optional color

color: AvColor | string

The color tint to apply to this model when it is displayed.

default

no tint

Optional debugName

debugName: string

A name that's applied to the node in the monitor and other tools. This name has no effect at runtime.

Optional id

id: string

This is the ID of the DOM element that is created as the parent of the component. It is used to reference other nodes in the gadget. If it is specified, it must be unique within the gadget.

default

none

Optional onIdAssigned

onIdAssigned: (addr: EndpointAddr) => void

Set this prop to be notified when the node is assigned its endpoint address. This is not necessary for most nodes.

Type declaration

    • (addr: EndpointAddr): void
    • Parameters

      • addr: EndpointAddr

      Returns void

Optional overlayOnly

overlayOnly: boolean

Only the parts of the model that are "on top" of another Aardvark-rendered pixel should be drawn. This can be used to draw Aardvark replacements for things that other Aardvark-drawn geometry may be hiding, such as hand models.

default

false

Optional persistentName

persistentName: string

An alias for debugName.

deprecated

Optional scaleToFit

scaleToFit: AvVector

Causes the model to be uniformly scaled up or down so that its bounding box touches at least one of the -x, +x, -y, +y, -z, or +z planes. Any axis that is 0 or unspecified will not be considered when computing the scale for the model.

This scaling happens inside any transforms on parent nodes.

default

No scaling

Optional sharedTexture

sharedTexture: AvSharedTextureInfo

Tells Aardvark to use this texture to replace the texture supplied by the model itself

uri

uri: string

The URI of the GLTF model to use for this model.

Optional useBrowserTexture

useBrowserTexture: boolean

Tells Aardvark to use the texture of this gadget's browser to replace the texture supplied by the model itself.

default

false

Optional useTextureFromUrl

useTextureFromUrl: string

Tells Aardvark to use the texture at the specified URL to override the texture baked into the model.

default

none

Optional visible

visible: boolean

Controls whether or not this node and its children are visible. If retaining the state of a node is important as it comes and goes, use the visible prop instead of omitting the node from the render function. This allows the renderer to retain the node's state even when you don't want it to draw.

default

true

Generated using TypeDoc