GeOnDT GeOnDT for JS

Class: UParticleEngine

GeOnDT.effect. UParticleEngine

GeOnDT ParticleEngine 객체 클래스

new UParticleEngine(app)

확산, 바람길, 오염, 눈, 비 객체 클래스

Name Type Description
app GeOnDT.U3dApp

형상화 주체 U3dApp 객체
Properties:
Name Type Argument Default Description
positionStyle number <optional>
 1

생성 Type, 생성시 Type 으로 설정 된 값 (초기값 : TYPE.CUBE = 1) {"CUBE": 1, "SPHERE": 2, "WIND": 3, "GRID": 4}
positionBase WorldPosition

위치 값
positionSpread Vector3

위치 범위 값
positionRadius number

positionStyle: TYPE.SPERE = 2으로 생성 시의 위치 범위 값
velocityStyle number

속도 및 방향 Type {"CUBE": 1, "SPHERE": 2, "WIND": 3, "GRID": 4}
velocityBase Vector3

초기 속도 및 방향
velocitySpread Vector3

초기 속도 및 방향 범위
speedBase number

velocityStyle: TYPE.SPERE = 2으로 생성 시 초기 속도
speedSpread number

velocityStyle: TYPE.SPERE = 2으로 생성 시 초기 속도 범위
accelerationBase Vector3

초기 가속도
accelerationSpread Vector3

초기 가속도 범위
angleBase number

초기 회전 값
angleSpread number

초기 회전 범위 값
angleVelocityBase number

초당 회전 값
angleVelocitySpread number

초당 회전 범위 값
angleAccelerationBase number

초당 회전 가속도 값
angleAccelerationSpread number

초당 회전 가속도 범위 값
sizeBase number

초기 크기
sizeSpread number

초기 크기 범위
sizeTween Object.XTween

시간대별 크기의 값의 정보를 담고 있는 객체 설정시 sizeBase, sizeSpread 무시
colorBase Vector3

초기 색상 값 (HSL format)
colorSpread Vector3

초기 색상 범위 (HSL format)
colorTween Object.XTween

시간대별 색상의 값의 정보를 담고 있는 객체 설정시 colorBase, colorSpread 무시
opacityBase number

초기 투명도
opacitySpread number

초기 투명도 범위
opacityTween Object.XTween

시간대별 투명도의 값의 정보를 담고 있는 객체 설정시 opacityBase, opacitySpread 무시
blendStyle number

blending style
particleArray Array.<array>

UParticle 객체를 담고 있는 배열
particlesPerSecond number

초당 UParticle 객체 생성 수량
particleDeathAge number

UParticle 객체 생명주기 (재생성 주기)
emitterAge number

순환주기 수치
emitterAlive boolean

순환주기 실행 여부
emitterDeathAge number

순환주기 종료 시간
particleCount number

전체 UParticle 객체 수량 (particlesPerSecond * Math.min(particleDeathAge,emitterDeathAge))
isStop boolean

업데이트 정지 여부
setDynamic boolean

카메라 위치 기반 생성 여부 ( 동적 생성 )
speed number

속도
height number

높이
Tutorials:
See:
  • GeonDT.analysis.UAnalyParticle
Example
let engine = new UParticleEngine(app);

Methods

createParticle()UParticle

particle 객체를 생성하는 함수 UParticleEngine.setValues(parameters) 를 통해서 설정된 값으로 생성

Returns:
Type Description
UParticle 기본 UParitcle 객체

createParticleObject()UParticle

UParticle 객체를 생성 후 반환하는 함수

Returns:
Type Description
UParticle 개별적인 particle 속성을 담고 있는 객체

createWindParticle()UParticle

바람길 particle 객체를 생성하는 함수 UParticleEngine.setWindValues(parameters) 를 통해서 설정된 값으로 생성

Returns:
Type Description
UParticle 바람길 UParitcle 객체

destroy(scene)

particle 형상 제거 함수

Name Type Default Description
scene Object.UScene this._scene optional

생성시 설정된 scene

getExtentsBoxByPosition()

바람길 타입으로 생성시 카메라 위치 기반 영역을 반영하여 갱신 하는 함수 (zoomlevel과 관련)

getMaskSearchType()number

MaskSearchType를 반환하는 함수

Returns:
Type Description
number (1 : base, 2 : raycast)

initialize()

particleMesh를 만들기 위한 작업을 하는 함수
내부적으로 createParticle() 호출

initializeWind(segments, height)UParticleEngine

particleMesh를 만들기 위한 작업을 하는 함수 내부적으로 createWindParticle() 호출

Name Type Default Description
segments number 1 optional

데이터 세분화 정도
height number

데이터 높이 설정
Returns:
Type Description
UParticleEngine 초기 설정된 UParticleEngine 객체

isShow()boolean

particle mesh visible 여부 반환 함수

Returns:
Type Description
boolean particle 객체 가시화 여부

randomValue(base, spread)number

기준값에서 범위 값 내의 무작위 값을 반환

Name Type Description
base number

기준값
spread number

범위값
Returns:
Type Description
number 기준값에서 범위 값 내의 무작위 값

randomVector3(base, spread)Vector3

기준 Vector3 값에서 범위 값내의 무작위 값을 반환

Name Type Description
base Vector3

기준 Vector3 값
spread Vector3

범위 Vector3 값
Returns:
Type Description
Vector3 기분 Vector3 값에서 범위 값내의 무작위 값 반환

setDynamicParameter(options)

바람길 타입으로 생성시 카메라 위치에 동적으로 생성 설정값 (setDynamic - true 일 경우 동작)

Name Type Description
options object

동적 생성시 설정값

Name Type Description
segments number

초기 세분화 정도
speed number

초기 속도 임계값
height number

초기 높이
sizeBase number

초기 크기

setLegend(func)

범례 색상 지정 함수

Name Type Description
func function

범례 지성 함수

setMask(particle, mask)

입력 받은 particle 객체에 mask 객체를 저장하는 함수 this._caacheMask에 설정한 mask 저장

Name Type Description
particle UParticle

mask를 설정한 particle 객체
mask object

particle에 전달할 mask 객체

setMaskSearchType(val)

MaskSearchType를 설정하는 함수

Name Type Description
val string | number

MaskSearchType을 설정하는 함수 ( base : 'base' || 1, raycast : 'raycase' || 2 )

setShpExtents(shpLayer)

입력 받은 shapeLayer를 통해 2d vector 영역으로 wind Particle의 생성 범위값 설정

Name Type Description
shpLayer U2dVectorLayer

영역 생성시 사용한 2dVectorLayer 레이어 객체

setStart()

particle의 update 동작을 실행하는 함수

setStop()

particle의 update를 정지하는 함수

setValues(parameters)

particle을 입력한 속성 값으로 설정 하는 함수

Name Type Description
parameters Object.Params.ParticleParam

속성값을 담은 객체

setWindValues(parameters, windData, extents)

바람길 객체의 particle을 입력한 속성 값으로 설정 하는 함수

Name Type Description
parameters Object.Params.ParticleParam

초기 position (설정한 영역을 벗어날 경우에 이 위치를 기준으로 다시 무작위 생성 )

Name Type Default Description
dampValue number 0.8 optional

particle seteffect true 시에 효과 크기 값
height number 10 optional

particle 초기 높이 값
maskSearchType number | string MASK_SEARCH_TYPE.BASIC optional

mask layer 설정시 mask value search 방식 설정 ( base : 'base' || 1 , raycast: 'raycast' || 2 )
setHeight boolean true optional

particle 동적 높이 설정 여부
setDynamic boolean false optional

particle 동적 생성 방식 설정 여부
legend function optional

particle 범례 지정 함수
forceVisible boolean false optional

낮은 가속도로 형상 표출 제외된 파티클 표시 여부
windData object

바람 데이터
extents object

영역 좌표

show(show)

particle mesh visible 여부 설정 함수

Name Type Description
show boolean

가시화 여부 설정 값

update(dt)

particle update 함수

Name Type Description
dt number

clock의 delta 값

updateWind(dt)

바람길 particle update 함수

Name Type Description
dt number

clock의 delta 값