Visit the Documentation of the upcoming Threlte 6.
  1. @threlte/core
  2. Group

@threlte/core

Group

This module is deprecated. You can still use it but it will be removed in the future. Please consider using <T>/<Three> instead. Please read the update notice.

This is almost identical to an <Object3D>. Its purpose is to make working with groups of objects syntactically clearer.

Import

Source

Github View Source Code

Package

NPM View Package

Related Docs


Example

<script>
  import { Group } from '@threlte/core'
  import { GLTF } from '@threlte/extras'
</script>

<Group position={{ x: 5 }}>
  <GLTF url={'/models/modelA.glb'} />
  <GLTF url={'/models/modelB.glb'} />
</Group>

Properties

// optional
position: Position | undefined = undefined
scale: Scale | undefined = undefined
rotation: Rotation | undefined = undefined
lookAt: LookAt | undefined = undefined
viewportAware: boolean = false
castShadow: boolean | undefined = undefined
receiveShadow: boolean | undefined = undefined
frustumCulled: boolean | undefined = undefined
renderOrder: number | undefined = undefined
visible: boolean | undefined = undefined
dispose: boolean | undefined = undefined
userData: Record<string, any> | undefined = undefined

Bindings

inViewport: boolean
group: THREE.Group

Events

viewportenter: undefined
viewportleave: undefined