# JSObject

> 객체 프로토 타입 API.

## properties

| Name          | Type                                                               | Description                  |
| ------------- | ------------------------------------------------------------------ | ---------------------------- |
| position      | [JSVector3D](/xdworld-webgl-manual/introduce-1/core/jsvector3d.md) | 객체 중심 좌표                     |
| layer         | string                                                             | 객체 부모 레이어 이름                 |
| object\_ahead | boolean                                                            | 지형 또는 시설물이 앞에 존재할 경우 비가시화 옵션 |

## Function

### getId() → string

> 객체의 고유 명칭을 반환 합니다.

{% tabs %}
{% tab title="Information" %}

* Return
  * string: 객체 설명 문자열이 성공적으로 반환.
  * null: 객체가 null인 경우.
    {% endtab %}

{% tab title="Template" %}

```javascript
var strKey = object.getId();
```

{% endtab %}
{% endtabs %}

### getLayerName() → string

> 객체 부모 레이어의 이름을 반환 합니다.

{% tabs %}
{% tab title="Information" %}

* Return
  * string: 객체 부모 레이어의 이름이 성공적으로 반환.
  * null: 객체가 null인 경우.
    {% endtab %}

{% tab title="Template" %}

```javascript
var strLayerName = object.getLayerName();
```

{% endtab %}
{% endtabs %}

### getObjectType() → number

> 객체의 타입을 반환 합니다.

{% tabs %}
{% tab title="Information" %}

* Return
  * number: 객체의 타입이 성공적으로 반환.
  * -1: 객체가 null인 경우.
    {% endtab %}

{% tab title="Template" %}

```javascript
var strObjectType = object.getObjectType();
```

{% endtab %}
{% endtabs %}

### getCenter() → [JSVector3D](/xdworld-webgl-manual/introduce-1/core/jsvector3d.md)

> 객체의 중심 좌표를 반환합니다.

{% tabs %}
{% tab title="Information" %}

* Return
  * [JSVector3D](/xdworld-webgl-manual/introduce-1/core/jsvector3d.md): 객체의 중심 반환.
  * null: 객체가 null인 경우.
    {% endtab %}

{% tab title="Template" %}

```javascript
var strObjectType = object.getObjectType();
```

{% endtab %}
{% endtabs %}

## Getter / Setter

### getDescription(), setDescription(desc) → string

> 객체에 대한 설명을 설정합니다.

{% tabs %}
{% tab title="Information" %}

| Name | Type   | Description |
| ---- | ------ | ----------- |
| desc | string | 설명 문자열.     |

* Return
  * string: 객체 설명 문자열이 성공적으로 반환.
  * null: 객체가 null인 경우.
    {% endtab %}

{% tab title="Template" %}

```javascript
var strDesc = object.getDescription();
// ... or ...
object.setDescription("First Object.");
```

{% endtab %}
{% endtabs %}

### getName(), setName(name) → string

> 객체 이름을 설정합니다.

{% tabs %}
{% tab title="Information" %}

| Name | Type   | Description |
| ---- | ------ | ----------- |
| name | string | 객체 이름.      |

* Return
  * string: 객체 이름을 성공적을 반환
  * null: 객체가 null인 경우.
    {% endtab %}

{% tab title="Template" %}

```javascript
var objName = object.getName();
// ... or ...
object.setName("MyObject");
```

{% endtab %}
{% endtabs %}

### getSelectable(), setSelectable(select) → boolean

> 객체의 선택(Selecting) 가능 여부를 설정합니다.

{% tabs %}
{% tab title="Information" %}

| Name   | Type    | Description                                |
| ------ | ------- | ------------------------------------------ |
| select | boolean | <p>true: 객체 선택 가능.<br>false: 객체 선택 불가.</p> |

* Return
  * `true` : 설정 성공
  * `false` : 설정 실패 (객체가 null인 경우 등)
    {% endtab %}

{% tab title="Template" %}

```javascript
object.setSelectable(true); // 선택 가능
```

{% endtab %}
{% endtabs %}

### getVisible(), setVisible(visible) → boolean

> 객체의 가시화 유무를 설정합니다.

{% tabs %}
{% tab title="Information" %}

| Name    | Type    | Description                             |
| ------- | ------- | --------------------------------------- |
| visible | boolean | <p>true: 객체 가시화.<br>false: 객체 비가시화.</p> |

* Return
  * true: 객체 가시화 상태.
  * false: 객체 비가시화 상태.
    {% endtab %}

{% tab title="Template" %}

```javascript
object.setVisible(true);
var visible = object.getVisible();
```

{% endtab %}
{% endtabs %}

### getPickable(), setPickable(value) → boolean

> 객체의 피킹(Picking) 가능 여부를 설정합니다.\
> 피킹 기능이 활성화된 경우, 마우스 이벤트 또는 선택 연산 시 해당 객체를 대상으로 인식할 수 있습니다.

{% tabs %}
{% tab title="Information" %}

| Name  | Type    | Description                   |
| ----- | ------- | ----------------------------- |
| value | boolean | `true`: 피킹 가능, `false`: 피킹 불가 |

* Return
  * `true` : 설정 성공
  * `false` : 설정 실패 (객체가 null인 경우 등)
    {% endtab %}

{% tab title="Template" %}

```javascript
const obj = Module.createPolygon("PICKABLE_OBJECT");
obj.setPickable(true); // 마우스 피킹 가능 설정
```

{% endtab %}
{% endtabs %}

### getUnderground(underground), setUnderground(value) → void

> 객체가 지형 높이와의 관계를 설정 및 반환합니다.

{% tabs %}
{% tab title="Information" %}

| Name         | Type   | Description                                           |
| ------------ | ------ | ----------------------------------------------------- |
| underground  | number | <p>0: 미정의.<br>1: 지형 위.<br>2: 지형 아래.<br>3: 지형 가운데.</p> |
| {% endtab %} |        |                                                       |

{% tab title="Template" %}

```javascript
const obj = Module.createPolygon("UNDERGROUND_OBJECT");
obj.setUnderground(2); // 지형 아래
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://egiscorp.gitbook.io/xdworld-webgl-manual/introduce-1/object/jsobject.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.