How To Setup The Cursor E-mail
Supplemental Object Documentation

1. Overview

The Cursor object is an input control and the main focal point within the environment by which objects can interact with.

2. Methods

 Selection <name>

Setup, and check the cursor selection buffers.

 Render <x> <y> <size>

Render the cursor at the specified coordinates.

 Update

Synchronize, and update the cursor for the next display buffer.

3. Properties

 Axes <vertex>

The coordinates generated from the rotation input.

 Button <boolean>

The selected button returned as on or off.

 Direction <vertex>

The look-at point of the cursor.

 Position <vertex>

The position point of the cursor.

 Relative <boolean>

The camera relativity which binds the object.

 Rotation <vertex>

The rotation factor of the cursor axes.

 Shader <shader>

The shader object.

4. Example

The following example is based upon the engine being initialized at which point a cursor is displayed and checks for the selected buffered objects .

' Game Basic 3D Engine Build 4096
' Copyright © Monarke Studios. All Rights Reserved.
 
Private Cursor As New GameBasic3D.Cursor
 
' Engine.Initialize
 
Do
 
    ' Engine.Begin
 
    ' Render object within the selection buffer
    Cursor.BeginSelection("...")
 
        Object.Render
    
    Cursor.EndSelection
 
    ' Render the cursor
    Cursor.Render _
    Cursor.Axes.X, _
    Cursor.Axes.Y, Size
 
    ' Synchronize, and update the cursor for the next display buffer
    Cursor.Update
 
    ' Engine.Synchronize
 
    If Cursor.CheckSelection("...") Then
 
        ' Preform Action
 
    End If
 
Loop
 
' Engine.End
 
Set Cursor = Nothing

5. Disclaimer 

Please note that the objects, and other various effects that can help extend the example are not entirely present but assume you're already familiar working with them. Please refer to the other online content, and technical reference included with the installation for further documentation.