Class: EntityObject
Defined in: packages/minerender/src/entity/scene/EntityObject.ts:23
Renders selected entity layers as named part groups. Create it through MineRenderScene.addEntity.
Extends
Constructors
Constructor
new EntityObject(entity, options?): EntityObject;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:41
Parameters
| Parameter | Type |
|---|---|
entity | EntityModel |
options? | Partial<EntityObjectOptions> |
Returns
EntityObject
Overrides
Properties
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|---|---|
_instanceCounter | public | number | 0 | - | - | SceneObject._instanceCounter | packages/minerender/src/renderer/SceneObject.ts:42 |
age | public | number | 0 | Entity age in ticks, as vanilla's ageInTicks; drives the scrolling render modes. | - | - | packages/minerender/src/entity/scene/EntityObject.ts:37 |
entity | readonly | EntityModel | undefined | - | - | - | packages/minerender/src/entity/scene/EntityObject.ts:41 |
isEntityObject | readonly | true | true | - | - | - | packages/minerender/src/entity/scene/EntityObject.ts:25 |
isSceneObject | readonly | true | true | - | - | SceneObject.isSceneObject | packages/minerender/src/renderer/SceneObject.ts:27 |
options | readonly | EntityObjectOptions | undefined | - | SceneObject.options | - | packages/minerender/src/entity/scene/EntityObject.ts:28 |
DEFAULT_OPTIONS | readonly | EntityObjectOptions | undefined | - | SceneObject.DEFAULT_OPTIONS | - | packages/minerender/src/entity/scene/EntityObject.ts:27 |
Accessors
activeAnimations
Get Signature
get activeAnimations(): readonly EntityAnimation[];Defined in: packages/minerender/src/entity/scene/EntityObject.ts:113
Clips playing together, in the order passed to playAnimations.
Returns
readonly EntityAnimation[]
animation
Get Signature
get animation(): Maybe<EntityAnimation>;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:108
The first active clip, until playback is stopped or the object is disposed.
Returns
animationTime
Get Signature
get animationTime(): number;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:131
Seconds since the animation started, before looping.
Returns
number
animationWeights
Get Signature
get animationWeights(): readonly number[];Defined in: packages/minerender/src/entity/scene/EntityObject.ts:122
Weights of the active clips, in the same order as activeAnimations.
Returns
readonly number[]
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
advanceAnimation()
advanceAnimation(deltaSeconds): void;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:196
Advances the animation by a frame delta in seconds, scaled by its speed. Has no effect without an animation.
Parameters
| Parameter | Type |
|---|---|
deltaSeconds | number |
Returns
void
dispose()
dispose(): void;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:58
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.
Overrides
disposeAndRemoveAllChildren()
disposeAndRemoveAllChildren(): void;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:62
Releases instance slots and removes children, disposing children that implement Disposable.
Returns
void
Overrides
SceneObject.disposeAndRemoveAllChildren
getGroupByName()
getGroupByName(name, layerName?): Maybe<Object3D<Object3DEventMap>>;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:209
Finds a part name without group:. Supply layerName to restrict the search to one draw.
Parameters
| Parameter | Type |
|---|---|
name | string |
layerName? | string |
Returns
Maybe<Object3D<Object3DEventMap>>
Overrides
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
getLayerGroup()
getLayerGroup(name): Maybe<Object3D<Object3DEventMap>>;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:204
Finds a selected draw by its layer key, such as main or main#2, or returns undefined.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
Maybe<Object3D<Object3DEventMap>>
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, layerName?): Maybe<Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>>;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:215
Finds a mesh name without mesh:. Supply layerName to restrict the search to one draw.
Parameters
| Parameter | Type |
|---|---|
name | string |
layerName? | string |
Returns
Maybe<Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>>
Overrides
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(material?): Promise<void>;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:49
An optional shared material replaces texture loading for every selected draw; its owner retains disposal.
Parameters
| Parameter | Type |
|---|---|
material? | Material<MaterialEventMap> |
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
playAnimation()
playAnimation(animation, options?): void;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:141
Plays a clip from Entities.getAnimations, replacing all active clips. Offsets apply to the baked pose in the clip's layer (main by default) and its repeated draws. A main clip also poses every selected layer without a clip of its own. The object owns no clock: call advanceAnimation per frame, or setAnimationTime.
Parameters
| Parameter | Type |
|---|---|
animation | EntityAnimation |
options? | EntityAnimationOptions |
Returns
void
playAnimations()
playAnimations(animations, options?): void;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:149
Plays clips with a shared clock, adding their weighted offsets within each geometry layer. Weights default to 1 and are not normalized. Selected layers without their own clip follow main.
Parameters
| Parameter | Type |
|---|---|
animations | readonly EntityAnimation[] |
options? | EntityAnimationOptions |
Returns
void
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
setAnimationTime()
setAnimationTime(seconds): void;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:190
Poses the object at an explicit time in seconds. Has no effect without an animation.
Parameters
| Parameter | Type |
|---|---|
seconds | number |
Returns
void
setAnimationWeights()
setAnimationWeights(weights): void;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:175
Changes weights in active clip order, notifying the scene without restarting the shared clock. Has no effect without an animation.
Parameters
| Parameter | Type |
|---|---|
weights | readonly number[] |
Returns
void
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
stopAnimation()
stopAnimation(): void;Defined in: packages/minerender/src/entity/scene/EntityObject.ts:183
Stops all clips and restores the poses from before playback.
Returns
void
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.