Class: GuiObject
Defined in: packages/minerender/src/gui/scene/GuiObject.ts:21
Renders ordered texture, item, and text layers. Create it through MineRenderScene.addGui. GUI coordinates grow right and down, with one pixel equal to one scene unit.
Extends
Constructors
Constructor
new GuiObject(textureLayers, options?): GuiObject;Defined in: packages/minerender/src/gui/scene/GuiObject.ts:31
Parameters
| Parameter | Type |
|---|---|
textureLayers | readonly GuiLayer[] |
options? | Partial<GuiObjectOptions> |
Returns
GuiObject
Overrides
Properties
| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
|---|---|---|---|---|---|---|
_instanceCounter | public | number | 0 | - | SceneObject._instanceCounter | packages/minerender/src/renderer/SceneObject.ts:42 |
bounds | readonly | Box2 | undefined | Local bounds in GUI pixels, with y growing down from the origin. | - | packages/minerender/src/gui/scene/GuiObject.ts:25 |
isGuiObject | readonly | true | true | - | - | packages/minerender/src/gui/scene/GuiObject.ts:23 |
isSceneObject | readonly | true | true | - | SceneObject.isSceneObject | packages/minerender/src/renderer/SceneObject.ts:27 |
options | readonly | SceneObjectOptions | undefined | - | SceneObject.options | packages/minerender/src/renderer/SceneObject.ts:35 |
textureLayers | readonly | readonly GuiLayer[] | undefined | - | - | packages/minerender/src/gui/scene/GuiObject.ts:31 |
DEFAULT_OPTIONS | readonly | SceneObjectOptions | undefined | - | SceneObject.DEFAULT_OPTIONS | packages/minerender/src/renderer/SceneObject.ts:29 |
Accessors
instanceCounter
Get Signature
get instanceCounter(): number;Defined in: packages/minerender/src/renderer/SceneObject.ts:246
Number of live placements, excluding released instance slots.
Returns
number
Inherited from
isInstanced
Get Signature
get isInstanced(): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:241
Returns
boolean
Inherited from
scene
Get Signature
get scene(): MineRenderScene;Defined in: packages/minerender/src/renderer/SceneObject.ts:58
Returns
Set Signature
set scene(scene): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:53
Parameters
| Parameter | Type |
|---|---|
scene | MineRenderScene |
Returns
void
Inherited from
Methods
dispose()
dispose(): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:523
Frees the GPU-related resources allocated by this instance.
Returns
void
Remarks
Call this method whenever this instance is no longer used in your app. Geometries, materials and textures are potentially shared with other 3D objects and must be disposed of separately.
Inherited from
disposeAndRemoveAllChildren()
disposeAndRemoveAllChildren(): void;Defined in: packages/minerender/src/gui/scene/GuiObject.ts:267
Releases instance slots and removes children, disposing children that implement Disposable.
Returns
void
Overrides
SceneObject.disposeAndRemoveAllChildren
getGroupByName()
getGroupByName(name): Maybe<Object3D<Object3DEventMap>>;Defined in: packages/minerender/src/renderer/SceneObject.ts:110
Finds a named part, such as head, without the internal group: prefix. Returns undefined when the group does not exist.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
Maybe<Object3D<Object3DEventMap>>
Inherited from
getInstanceReference()
getInstanceReference(mesh, index): Maybe<InstanceReference<SceneObject>>;Defined in: packages/minerender/src/renderer/SceneObject.ts:274
Returns the live reference for a raycast hit on this object's instance mesh.
Parameters
| Parameter | Type |
|---|---|
mesh | Object3D |
index | number |
Returns
Maybe<InstanceReference<SceneObject>>
Inherited from
SceneObject.getInstanceReference
getMatrixAt()
getMatrixAt(index, matrix?): Matrix4;Defined in: packages/minerender/src/renderer/SceneObject.ts:323
Parameters
| Parameter | Type |
|---|---|
index | number |
matrix | Matrix4 |
Returns
Matrix4
Inherited from
getMeshByName()
getMeshByName(name): Maybe<Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>>;Defined in: packages/minerender/src/renderer/SceneObject.ts:179
Finds a named mesh without the internal mesh: prefix, or returns undefined.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
Maybe<Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>>
Inherited from
getPosition()
getPosition(): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:457
Returns
Vector3
Inherited from
getPositionAt()
getPositionAt(index, vector?): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:394
Parameters
| Parameter | Type |
|---|---|
index | number |
vector | Vector3 |
Returns
Vector3
Inherited from
getRotation()
getRotation(): Euler;Defined in: packages/minerender/src/renderer/SceneObject.ts:477
Returns
Euler
Inherited from
getRotationAt()
getRotationAt(index, euler?): Euler;Defined in: packages/minerender/src/renderer/SceneObject.ts:406
Parameters
| Parameter | Type |
|---|---|
index | number |
euler | Euler |
Returns
Euler
Inherited from
getScale()
getScale(): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:497
Returns
Vector3
Inherited from
getScaleAt()
getScaleAt(index, vector?): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:418
Parameters
| Parameter | Type |
|---|---|
index | number |
vector | Vector3 |
Returns
Vector3
Inherited from
init()
init(): Promise<void>;Defined in: packages/minerender/src/gui/scene/GuiObject.ts:35
Returns
Promise<void>
Overrides
isInstanceActive()
isInstanceActive(index, reference): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:278
Parameters
| Parameter | Type |
|---|---|
index | number |
reference | InstanceReference<Instanceable> |
Returns
boolean
Inherited from
iterateAllMeshes()
iterateAllMeshes(cb): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:193
Parameters
| Parameter | Type |
|---|---|
cb | (mesh) => void |
Returns
void
Inherited from
nextInstance()
nextInstance(): InstanceReference<SceneObject>;Defined in: packages/minerender/src/renderer/SceneObject.ts:255
Allocates a placement of this instanced object, reusing a released slot when available.
Returns
InstanceReference<SceneObject>
Inherited from
notifyDirty()
notifyDirty(): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:67
Marks ancestor scenes for redraw and emits a change event.
Returns
void
Inherited from
removeFromScene()
removeFromScene(): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:554
Detaches the object from its parent and requests a redraw.
Returns
void
Inherited from
removeInstanceAt()
removeInstanceAt(index): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:282
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
void
Inherited from
setInstanceVisibleAt()
setInstanceVisibleAt(index, visible): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:347
Parameters
| Parameter | Type |
|---|---|
index | number |
visible | boolean |
Returns
void
Inherited from
SceneObject.setInstanceVisibleAt
setMatrixAt()
setMatrixAt(index, matrix): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:333
Parameters
| Parameter | Type |
|---|---|
index | number |
matrix | Matrix4 |
Returns
void
Inherited from
setPosition()
setPosition(position): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:446
Sets position in scene units. For a shared model, updates every live instance.
Parameters
| Parameter | Type |
|---|---|
position | Vector3 |
Returns
void
Inherited from
setPositionAt()
setPositionAt(index, position): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:389
Parameters
| Parameter | Type |
|---|---|
index | number |
position | Vector3 |
Returns
void
Inherited from
setPositionRotationScale()
setPositionRotationScale(
position?,
rotation?,
scale?
): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:426
Updates supplied transform components. For a shared model, affects every live instance.
Parameters
| Parameter | Type |
|---|---|
position? | Vector3 |
rotation? | Euler |
scale? | Vector3 |
Returns
void
Inherited from
SceneObject.setPositionRotationScale
setPositionRotationScaleAt()
setPositionRotationScaleAt(
index,
position?,
rotation?,
scale?
): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:368
Parameters
| Parameter | Type |
|---|---|
index | number |
position? | Vector3 |
rotation? | Euler |
scale? | Vector3 |
Returns
void
Inherited from
SceneObject.setPositionRotationScaleAt
setRotation()
setRotation(rotation): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:466
Sets rotation in radians. For a shared model, updates every live instance.
Parameters
| Parameter | Type |
|---|---|
rotation | Euler |
Returns
void
Inherited from
setRotationAt()
setRotationAt(index, rotation): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:401
Parameters
| Parameter | Type |
|---|---|
index | number |
rotation | Euler |
Returns
void
Inherited from
setScale()
setScale(scale): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:486
Sets scale factors. For a shared model, updates every live instance.
Parameters
| Parameter | Type |
|---|---|
scale | Vector3 |
Returns
void
Inherited from
setScaleAt()
setScaleAt(index, scale): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:413
Parameters
| Parameter | Type |
|---|---|
index | number |
scale | Vector3 |
Returns
void
Inherited from
toggleGroupVisibility()
toggleGroupVisibility(name, visible?): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:120
Changes a named group's visibility and requests a redraw.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Part name without the group: prefix. |
visible? | boolean | Visibility to assign. Omit it to toggle the current value. |
Returns
boolean
The resulting visibility, or false if the group does not exist.
Inherited from
SceneObject.toggleGroupVisibility
toggleMeshVisibility()
toggleMeshVisibility(name, visible?): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:189
Changes a named mesh's visibility and requests a redraw.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Mesh name without the mesh: prefix. |
visible? | boolean | Visibility to assign. Omit it to toggle the current value. |
Returns
boolean
The resulting visibility, or false if the mesh does not exist.