GeOnDT GeOnDT for JS

Class: UFrustumHelper

UFrustumHelper

~extends LineSegments2
프러스텀 외곽선과 지형 투영선을 그리는 helper 클래스입니다. LineSegments2를 기반으로 선 두께를 조절할수 있는 기능을 제공합니다.

new UFrustumHelper(frustum, options)

Name Type Default Description
frustum UFrustumHelperFrustum
options UFrustumHelperCO {} optional
Example
const helper = new UFrustumHelper(frustum, {
    color: 0x00ffff,
    lineWidth: 3,
    opacity: 0.6
});
scene.add(helper);

Members

terrainHeightSampleLayoutTerrainHeightSampleLayout undefined

Methods

dispose()

helper가 생성한 geometry, material, 투영선, cache를 해제하는 메서드입니다.

getFillColor()Color|string|number|undefined

Returns:
Type Description
Color | string | number | undefined

getFillOpacity()number|undefined

Returns:
Type Description
number | undefined

getSideColor()Color|string|number|undefined

Returns:
Type Description
Color | string | number | undefined

getSideOpacity()number|undefined

Returns:
Type Description
number | undefined

setColor(color)UFrustumHelper

helper 선 색상을 변경하는 메서드입니다.

Name Type Description
color Color | string | number
Returns:
Type Description
UFrustumHelper

setFillColor(color)UFrustumHelper

plane fill(비-terrain far plane mesh, terrain stamp) 색상을 변경한다. terrain stamp는 update() 시 fillOptions를 다시 읽어 반영된다.

Name Type Description
color Color | string | number | undefined
Returns:
Type Description
UFrustumHelper

setFillOpacity(opacity)UFrustumHelper

plane fill(비-terrain far plane mesh, terrain stamp) 투명도를 변경한다.

Name Type Description
opacity number | undefined
Returns:
Type Description
UFrustumHelper

setFrustum(frustum)UFrustumHelper

프러스텀 객체를 교체하고 현재 평면 정보로 helper geometry를 다시 만든다.

Name Type Description
frustum UFrustumHelperFrustum
Returns:
Type Description
UFrustumHelper

setGradientColor(color)UFrustumHelper

terrain stamp fill의 그라데이션 두 번째 색상을 변경한다. texture 옵션이 있으면 shader에서는 texture가 우선되어 gradient가 적용되지 않는다.

Name Type Description
color Color | string | number | undefined
Returns:
Type Description
UFrustumHelper

setGradientDirection(direction)UFrustumHelper

terrain stamp fill의 그라데이션 방향을 변경한다.

Name Type Description
direction 'vertical' | 'horizontal'
Returns:
Type Description
UFrustumHelper

setLineWidth(lineWidth)UFrustumHelper

helper 선 두께를 변경하는 메서드입니다.

Name Type Description
lineWidth number
Returns:
Type Description
UFrustumHelper

setOpacity(opacity)UFrustumHelper

helper 선 투명도를 변경하는 메서드입니다.

Name Type Description
opacity number
Returns:
Type Description
UFrustumHelper

setSideColor(color)UFrustumHelper

프러스텀 옆면 fill 색상을 변경한다. side mesh가 아직 없고 fill이 enabled면 이 시점에 생성해서 붙인다. color와 opacity가 모두 undefined가 되면 side mesh를 제거한다.

Name Type Description
color Color | string | number | undefined
Returns:
Type Description
UFrustumHelper

setSideOpacity(opacity)UFrustumHelper

프러스텀 옆면 fill 투명도를 변경한다. side mesh가 아직 없고 fill이 enabled면 이 시점에 생성해서 붙인다. color와 opacity가 모두 undefined가 되면 side mesh를 제거한다.

Name Type Description
opacity number | undefined
Returns:
Type Description
UFrustumHelper

setVisible(visible)UFrustumHelper

helper 전체 표시 상태를 변경한다. false이면 외곽선, side/fill mesh, projection line, terrain stamp fill/mask를 모두 끈다.

Name Type Description
visible boolean
Returns:
Type Description
UFrustumHelper

update()UFrustumHelper

현재 프러스텀 평면으로 외곽선을 갱신하는 메서드입니다.

Returns:
Type Description
UFrustumHelper

updateMatrixWorld(force)

프러스텀 matrix를 동기화한 뒤 LineSegments2의 world matrix를 갱신한다. geometry 재생성은 UFrustum change listener나 명시적인 helper.update()에서만 수행한다.

Name Type Description
force boolean optional