> For the complete documentation index, see [llms.txt](https://spectrexr.gitbook.io/octoxr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://spectrexr.gitbook.io/octoxr/user-interface/scripting/uipointer.md).

# UIPointer

Main pointer component. Needs a concrete <mark style="color:blue;">**IPointer**</mark> implementation as a reference in order to work.

Currently there are two concrete pointers (hand and controller). If you wish to implement your custom Pointer, just implement <mark style="color:blue;">**IPointer**</mark> interface and reference that object in pointers array.

### Public Events

UnityEvent OnStartSelect

* Will be invoked when pointer is hovering over UI element and start action is detected

UnityEvent OnStopSelect

* Will be invoked when start action ends

UnityEvent OnPointerEnterCanvas

UnityEvent OnPointerExitCanvas

### Public Methods

void UpdateCanvases()

* If you create canvas at runtime, call this method to update the pointer canvases list


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://spectrexr.gitbook.io/octoxr/user-interface/scripting/uipointer.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.
