SO3Engine
Functions
Virtual pointer

Functions

int SO3VirtualPointerCreate (mmachine m)
 main include
 
int SO3VirtualPointerSetMaxLength (mmachine m)
 SO3VirtualPointerSetMaxLength : defines the max raycast length.
 
int SO3VirtualPointerGetMaxLength (mmachine m)
 SO3VirtualPointerGetMaxLength : Get the virtual pointer max length.
 
int SO3VirtualPointerSetEnable (mmachine m)
 SO3VirtualPointerSetEnable : Enable or disable the virtual pointer.
 
int SO3VirtualPointerGetEnable (mmachine m)
 SO3VirtualPointerGetEnable : Get the virtual pointer active state.
 
int SO3VirtualPointerSetRayCastMode (mmachine m)
 SO3VirtualPointerSetRayCastMode : Set the virtual pointer raycast mode.
 
int SO3VirtualPointerUpdate (mmachine m)
 SO3VirtualPointerUpdate : Update virtual pointer raycast.
 
int SO3VirtualPointerSendClick (mmachine m)
 SO3VirtualPointerSendClick : Send a virtual pointer click.
 
int SO3VirtualPointerSendUnClick (mmachine m)
 SO3VirtualPointerSendUnClick : Send a virtual pointer unclick.
 
int SO3VirtualPointerSendWheel (mmachine m)
 SO3VirtualPointerSendWheel : Send a virtual pointer wheel.
 
int SO3VirtualPointerSendMove (mmachine m)
 SO3VirtualPointerSendMove : Send a virtual pointer move.
 
int SO3VirtualPointerHasWidgetUnder (mmachine m)
 SO3VirtualPointerHasWidgetUnder : Return if a widget have been hit by the raycast.
 
int SO3VirtualPointerGetId (mmachine m)
 SO3VirtualPointerGetId : Return the virtual pointer id.
 
int SO3VirtualPointerGetlength (mmachine m)
 SO3VirtualPointerGetlength : Return the last ray length.
 
int SO3VirtualPointerGetTargetPosition (mmachine m)
 SO3VirtualPointerGetTargetPosition : Return the last ray length.
 
int SO3VirtualPointerGetSelectedEntityName (mmachine m)
 SO3VirtualPointerGetSelectedEntityName : Return the last entity name found in ray.
 
int SO3VirtualPointerGetSelectedMaterialName (mmachine m)
 SO3VirtualPointerGetSelectedMaterialName : Return the last material name found in ray.
 
int SO3VirtualPointerGetRayInfos (mmachine m)
 SO3VirtualPointerGetRayInfos : Return the last ray infos.
 

Detailed Description

Scol functions definition

Function Documentation

◆ SO3VirtualPointerCreate()

int SO3VirtualPointerCreate ( mmachine  m)

main include

SO3VirtualPointerCreate : Create a new virtual pointer to raycast in scene from a position

Prototype: fun [SO3_SCENE S] SO3_OBJECT

Parameters
SO3_SCENE: current scene
S: given name for the new virtual pointer
Returns
SO3_OBJECT : Created virtual pointer if success , NIL otherwise

Definition at line 51 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerGetEnable()

int SO3VirtualPointerGetEnable ( mmachine  m)

SO3VirtualPointerGetEnable : Get the virtual pointer active state.

Prototype: fun [SO3_OBJECT] I

Parameters
SO3_OBJECT: current virtual pointer
Returns
I : state if success , NIL otherwise

Definition at line 234 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerGetId()

int SO3VirtualPointerGetId ( mmachine  m)

SO3VirtualPointerGetId : Return the virtual pointer id.

Prototype: fun [SO3_OBJECT] I

Parameters
SO3_OBJECT: current virtual pointer
Returns
I : the virtual pointer id, NIL otherwise

Definition at line 616 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerGetlength()

int SO3VirtualPointerGetlength ( mmachine  m)

SO3VirtualPointerGetlength : Return the last ray length.

Prototype: fun [SO3_OBJECT] F

Parameters
SO3_OBJECT: current virtual pointer
Returns
F : the length on success, NIL otherwise

Definition at line 663 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerGetMaxLength()

int SO3VirtualPointerGetMaxLength ( mmachine  m)

SO3VirtualPointerGetMaxLength : Get the virtual pointer max length.

Prototype: fun [SO3_OBJECT] F

Parameters
SO3_OBJECT: current virtual pointer
Returns
F : max length if success , NIL otherwise

Definition at line 149 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerGetRayInfos()

int SO3VirtualPointerGetRayInfos ( mmachine  m)

SO3VirtualPointerGetRayInfos : Return the last ray infos.

Prototype: fun [SO3_OBJECT] [SO3_SCENE SO3_OBJECT SO3_MATERIAL I [F F F] [F F] F]

Parameters
SO3_OBJECT: current virtual pointer
Returns
[SO3_SCENE SO3_OBJECT SO3_MATERIAL I [F F F] [F F] F] : the last ray infos on success, NIL otherwise
  • Scene
  • Object
  • Material
  • SubEntity index
  • Collision point coordinates
  • Uv coordinates of the collision point
  • Distance

Definition at line 885 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerGetSelectedEntityName()

int SO3VirtualPointerGetSelectedEntityName ( mmachine  m)

SO3VirtualPointerGetSelectedEntityName : Return the last entity name found in ray.

Prototype: fun [SO3_OBJECT] S

Parameters
SO3_OBJECT: current virtual pointer
Returns
S : the last entity name on success, NIL otherwise

Definition at line 768 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerGetSelectedMaterialName()

int SO3VirtualPointerGetSelectedMaterialName ( mmachine  m)

SO3VirtualPointerGetSelectedMaterialName : Return the last material name found in ray.

Prototype: fun [SO3_OBJECT] S

Parameters
SO3_OBJECT: current virtual pointer
Returns
S : the last material name on success, NIL otherwise

Definition at line 823 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerGetTargetPosition()

int SO3VirtualPointerGetTargetPosition ( mmachine  m)

SO3VirtualPointerGetTargetPosition : Return the last ray length.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters
SO3_OBJECT: current virtual pointer
Returns
[F F F] : the target position on success, NIL otherwise

Definition at line 710 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerHasWidgetUnder()

int SO3VirtualPointerHasWidgetUnder ( mmachine  m)

SO3VirtualPointerHasWidgetUnder : Return if a widget have been hit by the raycast.

Prototype: fun [SO3_OBJECT] I

Parameters
SO3_OBJECT: current virtual pointer
Returns
I : 1 if true, 0 if not, NIL otherwise

Definition at line 569 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerSendClick()

int SO3VirtualPointerSendClick ( mmachine  m)

SO3VirtualPointerSendClick : Send a virtual pointer click.

Prototype: fun [SO3_OBJECT I] I

Parameters
SO3_OBJECT: current virtual pointer
I: Mouse button (1, 2 or 16 for middle button)
Returns
I : 1 if success , NIL otherwise

Definition at line 370 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerSendMove()

int SO3VirtualPointerSendMove ( mmachine  m)

SO3VirtualPointerSendMove : Send a virtual pointer move.

Prototype: fun [SO3_OBJECT I] I

Parameters
SO3_OBJECT: current virtual pointer
I: Mouse button (0 for none, 1, 2 or 16 for middle button)
Returns
I : 1 on success, NIL otherwise

Definition at line 520 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerSendUnClick()

int SO3VirtualPointerSendUnClick ( mmachine  m)

SO3VirtualPointerSendUnClick : Send a virtual pointer unclick.

Prototype: fun [SO3_OBJECT I] I

Parameters
SO3_OBJECT: current virtual pointer
I: Mouse button (1, 2 or 16 for middle button)
Returns
I : 1 if success , NIL otherwise

Definition at line 420 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerSendWheel()

int SO3VirtualPointerSendWheel ( mmachine  m)

SO3VirtualPointerSendWheel : Send a virtual pointer wheel.

Prototype: fun [SO3_OBJECT I] I

Parameters
SO3_OBJECT: current virtual pointer
I: wheel delta
Returns
I : 1 on success, NIL otherwise

Definition at line 470 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerSetEnable()

int SO3VirtualPointerSetEnable ( mmachine  m)

SO3VirtualPointerSetEnable : Enable or disable the virtual pointer.

Prototype: fun [SO3_OBJECT I] I

Parameters
SO3_OBJECT: current virtual pointer
I: new state (0 to disable or 1 to enable)
Returns
I : 1 if success , NIL otherwise

Definition at line 191 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerSetMaxLength()

int SO3VirtualPointerSetMaxLength ( mmachine  m)

SO3VirtualPointerSetMaxLength : defines the max raycast length.

Prototype: fun [SO3_OBJECT F] I

Parameters
SO3_OBJECT: current virtual pointer
F: max length
Returns
I : 1 if success , NIL otherwise

Definition at line 100 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerSetRayCastMode()

int SO3VirtualPointerSetRayCastMode ( mmachine  m)

SO3VirtualPointerSetRayCastMode : Set the virtual pointer raycast mode.

Prototype: fun [SO3_OBJECT I] SO3_OBJECT

Parameters
SO3_OBJECT: current virtual pointer
I: 0 for fast mode (default) and 1 for limited mode (position is only retrieved on widgets textures), 2 for precise mode
Returns
I : the same virtual pointer object on success, NIL otherwise

Definition at line 275 of file SCOLVirtualPointer.cpp.

◆ SO3VirtualPointerUpdate()

int SO3VirtualPointerUpdate ( mmachine  m)

SO3VirtualPointerUpdate : Update virtual pointer raycast.

Prototype: fun [SO3_OBJECT] I

Parameters
SO3_OBJECT: current virtual pointer
Returns
I : 1 if success , NIL otherwise

Definition at line 322 of file SCOLVirtualPointer.cpp.

Generated by doxygen 1.9.8