Appearance

ObjectDescriptor ​

Descriptor for creating scene objects dynamically

Instance Methods ​

name() ​

javascript
name(value: string): ObjectDescriptor

Set the object name

Parameters:

  • value (string)

Returns: ObjectDescriptor

anchor() ​

javascript
anchor(anchor: Object): ObjectDescriptor

Set the anchor

Parameters:

  • anchor (Object) - Anchor descriptor created by Anchor static methods

Returns: ObjectDescriptor

traits() deprecated ​

Deprecated

Prefer the direct trait methods on the descriptor – .physics(…), .material(…), .gestures(…), .shadow(…), .transform(…), .opacity(…), .fittingBox(…), .pivot(…). They read the same, chain, and are the supported form going forward. .traits(fn) is kept only for compatibility with existing scripts and will be removed in a future runtime version.

javascript
traits(configureFn: function): ObjectDescriptor

Configure traits via a callback. Traits already on the descriptor (e.g. from createMesh({ materials: [...] })) are preserved – calls add on top.

Parameters:

  • configureFn (function) - Function that receives an ObjectTraits builder.

Returns: ObjectDescriptor

physics() ​

javascript
physics(options: Object): ObjectDescriptor

Give this object a physics body. See {@link ObjectTraits#physics} for the full options.

Parameters:

  • options (Object) - { mode, shape, mass, friction, restitution, … }.

Returns: ObjectDescriptor

gestures() ​

javascript
gestures(options: Object): ObjectDescriptor

Enable manipulation gestures (drag / rotate / resize). See {@link ObjectTraits#gestures}.

Parameters:

  • options (Object) - { drag, rotate, resize, releaseBehavior, … }.

Returns: ObjectDescriptor

material() ​

javascript
material(materialOrId: string | Material, target?: Object): ObjectDescriptor

Apply a material – a library id or an inline Material. See {@link ObjectTraits#material}.

Parameters:

  • materialOrId (string | Material)
  • target (Object) (optional) - Optional model / slot target.

Returns: ObjectDescriptor

shadow() ​

javascript
shadow(options: Object): ObjectDescriptor

Configure the object's shadows (directional + grounding). See {@link ObjectTraits#shadow}.

Parameters:

  • options (Object) - { directional, grounding }.

Returns: ObjectDescriptor

transform() ​

javascript
transform(transform: Object): ObjectDescriptor

Set the object's transform (position / rotation / scale). See {@link ObjectTraits#transform}.

Parameters:

  • transform (Object)

Returns: ObjectDescriptor

opacity() ​

javascript
opacity(opacity: number): ObjectDescriptor

Set the object's opacity (0–1). See {@link ObjectTraits#opacity}.

Parameters:

  • opacity (number)

Returns: ObjectDescriptor

fittingBox() ​

javascript
fittingBox(size: number): ObjectDescriptor

Scale a model to fit a box of the given size. See {@link ObjectTraits#fittingBox}.

Parameters:

  • size (number)

Returns: ObjectDescriptor

pivot() ​

javascript
pivot(pivot: string): ObjectDescriptor

Adjust the model's pivot. See {@link ObjectTraits#pivot}.

Parameters:

  • pivot (string)

Returns: ObjectDescriptor