Class Sprite3D

3D 공간에서 항상 카메라를 향하는 2D 스프라이트 객체

Sprite3D는 Mesh 클래스를 상속받아 빌보드 기능을 제공하는 클래스입니다. 빌보드는 3D 공간에 배치되지만 항상 카메라 방향을 바라보는 평면 객체로, UI 요소, 파티클, 텍스트, 아이콘 등을 3D 씬에 표시할 때 유용합니다.

아래는 Sprite3D의 구조와 동작을 이해하는 데 도움이 되는 추가 샘플 예제 목록입니다.

See

Sprite3D MouseEvent example

Hierarchy (View Summary)

Mesh
- Sprite3D

Index

Constructors

constructor

Constructors

constructor

new Sprite3D(
    redGPUContext: RedGPUContext,
    material?: any,
    geometry?: Geometry | Primitive.Core.Primitive,
): Sprite3D
새로운 Sprite3D 인스턴스를 생성합니다.
Parameters
- redGPUContext: RedGPUContext
  RedGPU 렌더링 컨텍스트
- Optionalmaterial: any
  스프라이트에 적용할 머티리얼 (옵션)
- Optionalgeometry: Geometry | Primitive.Core.Primitive
  스프라이트의 지오메트리 (기본값: 새로운 Plane 인스턴스)
Returns Sprite3D
Inherited from Mesh.constructor
- Defined in src/display/sprites/sprite3D/Sprite3D.ts:56

Properties

_geometry

_geometry: Geometry | Primitive.Core.Primitive

_material

_material: any

animationInfo

animationInfo: {
    animationsList: GLTFParsedSingleClip[];
    jointBuffer: IndexBuffer;
    morphInfo: MorphInfo_GLTF;
    skinInfo: ParsedSkinInfo_GLTF;
    weightBuffer: VertexBuffer;
} = ...

billboardFixedScale

billboardFixedScale: number

빌보드 고정 크기 배율

useBillboardPerspective가 false일때만 적용됩니다.

castShadow

castShadow: boolean = false

그림자 캐스팅 여부

dirtyOpacity

dirtyOpacity: boolean = true

dirtyPipeline

dirtyPipeline: boolean = true

dirtyTransform

dirtyTransform: boolean = true

disableJitter

disableJitter: boolean

displacementTexture

displacementTexture: BitmapTexture

메시의 디스플레이스먼트 텍스처

gltfLoaderInfo

gltfLoaderInfo: GLTFLoader

gpuRenderInfo

gpuRenderInfo: VertexGPURenderInfo

localMatrix

localMatrix: mat4 = ...

meshType

meshType: string

modelMatrix

modelMatrix: mat4 = ...

이 객체의 모델 행렬입니다. 위치, 회전, 스케일 변환에 사용됩니다.

normalModelMatrix

normalModelMatrix: mat4 = ...

receiveShadow

receiveShadow: boolean

useBillboard

useBillboard: boolean

빌보드 모드 사용 여부

useBillboardPerspective

useBillboardPerspective: boolean

빌보드 원근감 적용 여부

useDisplacementTexture

useDisplacementTexture: boolean

Accessors

boundingAABB

get boundingAABB(): AABB
Returns AABB
- Defined in src/display/mesh/Mesh.ts:367

boundingOBB

get boundingOBB(): OBB
Returns OBB
- Defined in src/display/mesh/Mesh.ts:358

children

get children(): Mesh[]
현재 컨테이너에 포함된 자식 Mesh 배열을 반환합니다.

Returns Mesh[]
자식 객체 배열
- Defined in src/display/mesh/core/Object3DContainer.ts:41

combinedBoundingAABB

get combinedBoundingAABB(): AABB
Returns AABB
- Defined in src/display/mesh/Mesh.ts:376

currentShaderModuleName

get currentShaderModuleName(): string
Returns string
- Defined in src/display/mesh/core/MeshBase.ts:73
set currentShaderModuleName(value: string): void
Parameters
- value: string
Returns void
- Defined in src/display/mesh/core/MeshBase.ts:77

depthStencilState

get depthStencilState(): DepthStencilState
Returns DepthStencilState
- Defined in src/display/mesh/core/MeshBase.ts:86

drawDebugger

get drawDebugger(): DrawDebuggerMesh
Returns DrawDebuggerMesh
- Defined in src/display/mesh/Mesh.ts:153

enableDebugger

get enableDebugger(): boolean
Returns boolean
- Defined in src/display/mesh/Mesh.ts:144
set enableDebugger(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/display/mesh/Mesh.ts:148

events

get events(): any
Returns any
- Defined in src/display/mesh/Mesh.ts:205

geometry

get geometry(): Geometry | Primitive.Core.Primitive
Returns Geometry | Primitive.Core.Primitive
- Defined in src/display/mesh/Mesh.ts:173
set geometry(value: Geometry | Primitive.Core.Primitive): void
Parameters
- value: Geometry | Primitive.Core.Primitive
Returns void
- Defined in src/display/mesh/Mesh.ts:177

gpuDevice

get gpuDevice(): GPUDevice
Retrieves the GPU device associated with the current instance.

Returns GPUDevice
The GPU device.
- Defined in src/display/mesh/core/MeshBase.ts:94

ignoreFrustumCulling

get ignoreFrustumCulling(): boolean
Returns boolean
- Defined in src/display/mesh/Mesh.ts:193
set ignoreFrustumCulling(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/display/mesh/Mesh.ts:197

material

get material(): any
Returns any
- Defined in src/display/mesh/Mesh.ts:158
set material(value: any): void
Parameters
- value: any
Returns void
- Defined in src/display/mesh/Mesh.ts:162

name

get name(): string
Returns string
- Defined in src/display/mesh/Mesh.ts:209
set name(value: string): void
Parameters
- value: string
Returns void
- Defined in src/display/mesh/Mesh.ts:214

numChildren

get numChildren(): number
자식 객체의 개수를 반환합니다.

Returns number
자식 수
- Defined in src/display/mesh/core/Object3DContainer.ts:49

opacity

get opacity(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:183
set opacity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:187

parent

get parent(): Object3DContainer
설정된 부모 객체값을 반환합니다.

Returns Object3DContainer
- Defined in src/display/mesh/Mesh.ts:225
set parent(value: Object3DContainer): void
부모 객체를 설정합니다.
Parameters
- value: Object3DContainer
Returns void
- Defined in src/display/mesh/Mesh.ts:233

pickingId

get pickingId(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:201

pivotX

get pivotX(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:237
set pivotX(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:241

pivotY

get pivotY(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:246
set pivotY(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:250

pivotZ

get pivotZ(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:255
set pivotZ(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:259

position

get position(): Float32Array
Returns Float32Array
- Defined in src/display/mesh/Mesh.ts:291

primitiveState

get primitiveState(): PrimitiveState
Returns PrimitiveState
- Defined in src/display/mesh/core/MeshBase.ts:82

redGPUContext

get redGPUContext(): RedGPUContext
Retrieves the RedGPUContext instance.

Returns RedGPUContext
The RedGPUContext instance.
- Defined in src/display/mesh/core/MeshBase.ts:103

rotation

get rotation(): Float32Array
Returns Float32Array
- Defined in src/display/mesh/Mesh.ts:354

rotationX

get rotationX(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:326
set rotationX(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:330

rotationY

get rotationY(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:336
set rotationY(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:340

rotationZ

get rotationZ(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:345
set rotationZ(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:349

scale

get scale(): Float32Array
Returns Float32Array
- Defined in src/display/mesh/Mesh.ts:322

scaleX

get scaleX(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:295
set scaleX(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:299

scaleY

get scaleY(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:304
set scaleY(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:308

scaleZ

get scaleZ(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:313
set scaleZ(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:317

uuid

get uuid(): string
Retrieves the UUID of the object.

Returns string
The UUID of the object.
- Defined in src/display/mesh/core/MeshBase.ts:69

vertexStateBuffers

get vertexStateBuffers(): GPUVertexBufferLayout[]
Returns GPUVertexBufferLayout[]
- Defined in src/display/mesh/Mesh.ts:218

x

get x(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:264
set x(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:268

y

get y(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:273
set y(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:277

z

get z(): number
Returns number
- Defined in src/display/mesh/Mesh.ts:282
set z(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/mesh/Mesh.ts:286

Methods

__fireListenerList

__fireListenerList(resetList?: boolean): void
Fires the dirty listeners list.
Parameters
- OptionalresetList: boolean = false
  Indicates whether to reset the dirty listeners list after firing.
Returns void
Inherited from Mesh.__fireListenerList
- Defined in src/display/mesh/core/MeshBase.ts:124

addChild

addChild(child: Mesh): Mesh
자식 Mesh를 컨테이너에 추가합니다.
Parameters
- child: Mesh
  추가할 자식 객체
Returns Mesh
추가된 객체 또는 실패 시 null
Inherited from Mesh.addChild
- Defined in src/display/mesh/core/Object3DContainer.ts:68

addChildAt

addChildAt(child: Mesh, index: number): Sprite3D
자식 Mesh를 특정 인덱스에 추가합니다.
Parameters
- child: Mesh
  추가할 자식 객체
- index: number
  삽입 위치
Returns Sprite3D
현재 컨테이너
Inherited from Mesh.addChildAt
- Defined in src/display/mesh/core/Object3DContainer.ts:86

addListener

addListener(eventName: string, callback: Function): void
Parameters
- eventName: string
- callback: Function
Returns void
Inherited from Mesh.addListener
- Defined in src/display/mesh/Mesh.ts:421

clone

clone(): Mesh
Returns Mesh
Inherited from Mesh.clone
- Defined in src/display/mesh/Mesh.ts:471

contains

contains(child: Mesh): boolean
특정 Mesh가 현재 컨테이너에 포함되어 있는지 확인합니다.
Parameters
- child: Mesh
  확인할 자식 객체
Returns boolean
포함 여부
Inherited from Mesh.contains
- Defined in src/display/mesh/core/Object3DContainer.ts:58

createCustomMeshVertexShaderModule

createCustomMeshVertexShaderModule(): GPUShaderModule
Sprite3D 전용 커스텀 버텍스 셰이더 모듈을 생성합니다.

이 메서드는 빌보드 기능을 지원하는 전용 버텍스 셰이더를 생성합니다. 일반 메시와 달리 카메라 방향에 따라 정점 위치를 동적으로 계산하는 셰이더 로직이 포함되어 있습니다.

Returns GPUShaderModule
생성된 버텍스 셰이더 모듈 정보
- Defined in src/display/sprites/sprite3D/Sprite3D.ts:76

createMeshVertexShaderModuleBASIC

createMeshVertexShaderModuleBASIC(
    VERTEX_SHADER_MODULE_NAME: any,
    SHADER_INFO: any,
    UNIFORM_STRUCT_BASIC: any,
    vertexModuleSource: any,
): GPUShaderModule
Parameters
- VERTEX_SHADER_MODULE_NAME: any
- SHADER_INFO: any
- UNIFORM_STRUCT_BASIC: any
- vertexModuleSource: any
Returns GPUShaderModule
Inherited from Mesh.createMeshVertexShaderModuleBASIC
- Defined in src/display/mesh/Mesh.ts:1067

getChildAt

getChildAt(index: number): Mesh
지정된 인덱스의 자식 Mesh를 반환합니다.
Parameters
- index: number
  조회할 위치
Returns Mesh
해당 위치의 자식 객체 또는 undefined
Inherited from Mesh.getChildAt
- Defined in src/display/mesh/core/Object3DContainer.ts:108

getChildIndex

getChildIndex(child: Mesh): number
특정 자식 객체의 인덱스를 반환합니다.
Parameters
- child: Mesh
  조회할 자식 객체
Returns number
인덱스 또는 -1
Inherited from Mesh.getChildIndex
- Defined in src/display/mesh/core/Object3DContainer.ts:122

getCombinedOpacity

getCombinedOpacity(): number
Returns number
Inherited from Mesh.getCombinedOpacity
- Defined in src/display/mesh/Mesh.ts:413

getScreenPoint

getScreenPoint(view: View3D): [number, number]
Parameters
- view: View3D
Returns [number, number]
Inherited from Mesh.getScreenPoint
- Defined in src/display/mesh/core/MeshBase.ts:115

initGPURenderInfos

initGPURenderInfos(): void
Returns void
Inherited from Mesh.initGPURenderInfos
- Defined in src/display/mesh/Mesh.ts:1053

localToWorld

localToWorld(x: number, y: number, z: number): [number, number, number]
Parameters
- x: number
- y: number
- z: number
Returns [number, number, number]
Inherited from Mesh.localToWorld
- Defined in src/display/mesh/core/MeshBase.ts:111

lookAt

lookAt(
    targetX: number | [number, number, number],
    targetY?: number,
    targetZ?: number,
): void
Parameters
- targetX: number | [number, number, number]
- OptionaltargetY: number
- OptionaltargetZ: number
Returns void
Inherited from Mesh.lookAt
- Defined in src/display/mesh/Mesh.ts:426

removeAllChildren

removeAllChildren(): Sprite3D
모든 자식 객체를 제거합니다.

Returns Sprite3D
현재 컨테이너
Inherited from Mesh.removeAllChildren
- Defined in src/display/mesh/core/Object3DContainer.ts:231

removeChild

removeChild(child: Mesh): Mesh
특정 자식 객체를 제거합니다.
Parameters
- child: Mesh
  제거할 자식 객체
Returns Mesh
제거된 객체
Inherited from Mesh.removeChild
- Defined in src/display/mesh/core/Object3DContainer.ts:200

removeChildAt

removeChildAt(index: number): Mesh
지정된 인덱스의 자식 객체를 제거합니다.
Parameters
- index: number
  제거할 위치
Returns Mesh
제거된 객체
Inherited from Mesh.removeChildAt
- Defined in src/display/mesh/core/Object3DContainer.ts:216

render

render(renderViewStateData: RenderViewStateData): void
Parameters
- renderViewStateData: RenderViewStateData
Returns void
Inherited from Mesh.render
- Defined in src/display/mesh/Mesh.ts:486

setCastShadowRecursively

setCastShadowRecursively(castShadow?: boolean): void
Parameters
- castShadow: boolean = false
Returns void
Inherited from Mesh.setCastShadowRecursively
- Defined in src/display/mesh/Mesh.ts:391

setChildIndex

setChildIndex(child: Mesh, index: number): void
자식 객체의 위치를 변경합니다.
Parameters
- child: Mesh
  대상 자식 객체
- index: number
  새 인덱스
Returns void
Inherited from Mesh.setChildIndex
- Defined in src/display/mesh/core/Object3DContainer.ts:137

setEnableDebuggerRecursively

setEnableDebuggerRecursively(enableDebugger?: boolean): void
Parameters
- enableDebugger: boolean = false
Returns void
Inherited from Mesh.setEnableDebuggerRecursively
- Defined in src/display/mesh/Mesh.ts:380

setPosition

setPosition(x: number, y?: number, z?: number): void
Parameters
- x: number
- Optionaly: number
- Optionalz: number
Returns void
Inherited from Mesh.setPosition
- Defined in src/display/mesh/Mesh.ts:451

setReceiveShadowRecursively

setReceiveShadowRecursively(receiveShadow?: boolean): void
Parameters
- receiveShadow: boolean = false
Returns void
Inherited from Mesh.setReceiveShadowRecursively
- Defined in src/display/mesh/Mesh.ts:402

setRotation

setRotation(rotationX: number, rotationY?: number, rotationZ?: number): void
Parameters
- rotationX: number
- OptionalrotationY: number
- OptionalrotationZ: number
Returns void
Inherited from Mesh.setRotation
- Defined in src/display/mesh/Mesh.ts:461

setScale

setScale(x: number, y?: number, z?: number): void
Parameters
- x: number
- Optionaly: number
- Optionalz: number
Returns void
Inherited from Mesh.setScale
- Defined in src/display/mesh/Mesh.ts:441

swapChildren

swapChildren(child1: Mesh, child2: Mesh): void
두 자식 객체의 위치를 서로 바꿉니다.
Parameters
- child1: Mesh
  첫 번째 객체
- child2: Mesh
  두 번째 객체
Returns void
Inherited from Mesh.swapChildren
- Defined in src/display/mesh/core/Object3DContainer.ts:160

swapChildrenAt

swapChildrenAt(index1: number, index2: number): void
두 인덱스의 자식 객체 위치를 서로 바꿉니다.
Parameters
- index1: number
  첫 번째 인덱스
- index2: number
  두 번째 인덱스
Returns void
Inherited from Mesh.swapChildrenAt
- Defined in src/display/mesh/core/Object3DContainer.ts:180

worldToLocal

worldToLocal(x: number, y: number, z: number): [number, number, number]
Parameters
- x: number
- y: number
- z: number
Returns [number, number, number]
Inherited from Mesh.worldToLocal
- Defined in src/display/mesh/core/MeshBase.ts:107

Class Sprite3D

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Sprite3D

Properties

_geometry

_material

animationInfo

billboardFixedScale

castShadow

dirtyOpacity

dirtyPipeline

dirtyTransform

disableJitter

displacementTexture

gltfLoaderInfo

gpuRenderInfo

localMatrix

meshType

modelMatrix

normalModelMatrix

receiveShadow

useBillboard

useBillboardPerspective

useDisplacementTexture

Accessors

boundingAABB

Returns AABB

boundingOBB

Returns OBB

children

Returns Mesh[]

combinedBoundingAABB

Returns AABB

currentShaderModuleName

Returns string

Parameters

Returns void

depthStencilState

Returns DepthStencilState

drawDebugger

Returns DrawDebuggerMesh

enableDebugger

Returns boolean

Parameters

Returns void

events

Returns any

geometry

Returns Geometry | Primitive.Core.Primitive

Parameters

Returns void

gpuDevice

Returns GPUDevice

ignoreFrustumCulling

Returns boolean

Parameters

Returns void

material

Returns any

Parameters

Returns void

name

Returns string

Parameters

Returns void

numChildren

Returns number

opacity

Returns number

Parameters

Returns void