Project

General

Profile

SO3Engine
Functions
LineEntity

Functions

int SO3LineEntityCreate (mmachine m)
 main include
 
int SO3LineEntityCreateDashed (mmachine m)
 SO3LineEntityCreateDashed : Create a new line entity.
 
int SO3LineEntityCreateEx (mmachine m)
 SO3LineEntityCreateEx : Create a new line entity.
 
int SO3LineEntityCreateDashedEx (mmachine m)
 SO3LineEntityCreateDashedEx : Create a new line entity.
 
int SO3LineEntityGetDiffuse (mmachine m)
 SO3LineEntityGetDiffuse : Retrieves the color of the line (RGBA)
 
int SO3LineEntitySetDiffuse (mmachine m)
 SO3LineEntitySetDiffuse : Set the color of the line (RGBA)
 
int SO3LineEntityGetPoint (mmachine m)
 SO3LineEntityGetPoint : Retrieves the position of an existing point of the line.
 
int SO3LineEntitySetPoint (mmachine m)
 SO3LineEntitySetPoint : Sets the position of an existing point of the line.
 
int SO3LineEntityAddPoint (mmachine m)
 SO3LineEntityAddPoint : Add a new point on the line, after the indicated position.
 
int SO3LineEntityRemovePoint (mmachine m)
 SO3LineEntityRemovePoint : Removes an existing point on the line, at the indicated position.
 
int SO3LineEntityGetNumberOfPoints (mmachine m)
 SO3LineEntityGetNumberOfPoints : Retrieves the numbers of points composing the line.
 
int SO3LineEntityGetPoints (mmachine m)
 SO3LineEntityGetPoints : Retrieves the list of points positions.
 
int SO3LineEntitySetPoints (mmachine m)
 SO3LineEntitySetPoints : Set all the points of the line in a single call.
 
int SO3LineEntityClearPoints (mmachine m)
 SO3LineEntityClearPoints : Clear all the points of the line.
 
int SO3LineEntitySetDashed (mmachine m)
 SO3LineEntitySetDashed : Change the drawing mode of the line.
 
int SO3LineEntityGetDashed (mmachine m)
 SO3LineEntityGetDashed : Get the drawing mode of the line.
 

Detailed Description

Scol functions definition

Function Documentation

◆ SO3LineEntityAddPoint()

int SO3LineEntityAddPoint ( mmachine  m)

SO3LineEntityAddPoint : Add a new point on the line, after the indicated position.

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

Parameters
SO3_OBJECT: target line entity
I: index of the point (starting to 0). Last point if NIL.
[FF F] : the position of the point
Returns
I : 1 if success, NIL otherwise

Definition at line 623 of file SCOLLineEntity.cpp.

◆ SO3LineEntityClearPoints()

int SO3LineEntityClearPoints ( mmachine  m)

SO3LineEntityClearPoints : Clear all the points of the line.

Prototype: fun [SO3_OBJECT] I

Parameters
SO3_OBJECT: target line entity
Returns
I : 1 if success, NIL otherwise

Definition at line 946 of file SCOLLineEntity.cpp.

◆ SO3LineEntityCreate()

int SO3LineEntityCreate ( mmachine  m)

main include

SO3LineEntityCreate : Create a new line entity

Prototype: fun [SO3_SCENE S [[F F F] r1] I] SO3_OBJECT

Parameters
SO3_SCENE: target scene
S: given name for the new line entity
[[FF F] r1] : list of points, can be NIL
I: line color (RGBA), can be NIL, in which case default "white" color will be use.
Returns
SO3_OBJECT : Created a line entity if success , NIL otherwise

Definition at line 53 of file SCOLLineEntity.cpp.

◆ SO3LineEntityCreateDashed()

int SO3LineEntityCreateDashed ( mmachine  m)

SO3LineEntityCreateDashed : Create a new line entity.

Prototype: fun [SO3_SCENE S [[F F F] r1] I] SO3_OBJECT

Parameters
SO3_SCENE: target scene
S: given name for the new line entity
[[FF F] r1] : list of points, can be NIL
I: line color (RGBA), can be NIL, in which case default "white" color will be use.
Returns
SO3_OBJECT : Created a line entity if success , NIL otherwise

Definition at line 135 of file SCOLLineEntity.cpp.

◆ SO3LineEntityCreateDashedEx()

int SO3LineEntityCreateDashedEx ( mmachine  m)

SO3LineEntityCreateDashedEx : Create a new line entity.

Prototype: fun [SO3_SCENE S [[F F F] r1] I I] SO3_OBJECT

Parameters
SO3_SCENE: target scene
S: given name for the new line entity
[[FF F] r1] : list of points, can be NIL
I: line color (RGBA), can be NIL, in which case default "white" color will be use.
I: depth check off
Returns
SO3_OBJECT : Created a line entity if success , NIL otherwise

Definition at line 307 of file SCOLLineEntity.cpp.

◆ SO3LineEntityCreateEx()

int SO3LineEntityCreateEx ( mmachine  m)

SO3LineEntityCreateEx : Create a new line entity.

Prototype: fun [SO3_SCENE S [[F F F] r1] I I] SO3_OBJECT

Parameters
SO3_SCENE: target scene
S: given name for the new line entity
[[FF F] r1] : list of points, can be NIL
I: line color (RGBA), can be NIL, in which case default "white" color will be use.
I: depth check off
Returns
SO3_OBJECT : Created a line entity if success , NIL otherwise

Definition at line 218 of file SCOLLineEntity.cpp.

◆ SO3LineEntityGetDashed()

int SO3LineEntityGetDashed ( mmachine  m)

SO3LineEntityGetDashed : Get the drawing mode of the line.

Prototype: fun [SO3_OBJECT] I

Parameters
SO3_OBJECT: target line entity
Returns
I : 1 if dashed, 0 if normal line, NIL otherwise

Definition at line 1050 of file SCOLLineEntity.cpp.

◆ SO3LineEntityGetDiffuse()

int SO3LineEntityGetDiffuse ( mmachine  m)

SO3LineEntityGetDiffuse : Retrieves the color of the line (RGBA)

Prototype: fun [SO3_OBJECT] I

Parameters
SO3_OBJECT: target line object
Returns
I : Diffuse color (rgba) if success, NIL otherwise

Definition at line 391 of file SCOLLineEntity.cpp.

◆ SO3LineEntityGetNumberOfPoints()

int SO3LineEntityGetNumberOfPoints ( mmachine  m)

SO3LineEntityGetNumberOfPoints : Retrieves the numbers of points composing the line.

Prototype: fun [SO3_OBJECT] I

Parameters
SO3_OBJECT: target line entity
Returns
I : Number of points if success, NIL otherwise

Definition at line 747 of file SCOLLineEntity.cpp.

◆ SO3LineEntityGetPoint()

int SO3LineEntityGetPoint ( mmachine  m)

SO3LineEntityGetPoint : Retrieves the position of an existing point of the line.

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

Parameters
SO3_OBJECT: target line entity
I: index of the point (starting to 0). Last point if NIL.
Returns
[F F F] : the position of the point if success, NIL otherwise

Definition at line 485 of file SCOLLineEntity.cpp.

◆ SO3LineEntityGetPoints()

int SO3LineEntityGetPoints ( mmachine  m)

SO3LineEntityGetPoints : Retrieves the list of points positions.

Prototype: fun [SO3_OBJECT] [[F F F] r1]

Parameters
SO3_OBJECT: target line entity
Returns
[[F F F] r1] : The list of points positions if success, NIL otherwise

Definition at line 795 of file SCOLLineEntity.cpp.

◆ SO3LineEntityRemovePoint()

int SO3LineEntityRemovePoint ( mmachine  m)

SO3LineEntityRemovePoint : Removes an existing point on the line, at the indicated position.

Prototype: fun [SO3_OBJECT I] I

Parameters
SO3_OBJECT: target line entity
I: index of the point (starting to 0). Last point if NIL.
Returns
I : 1 if success, NIL otherwise

Definition at line 686 of file SCOLLineEntity.cpp.

◆ SO3LineEntitySetDashed()

int SO3LineEntitySetDashed ( mmachine  m)

SO3LineEntitySetDashed : Change the drawing mode of the line.

Prototype: fun [SO3_OBJECT I] I

Parameters
SO3_OBJECT: target line entity
I: 0 for normal line, 1 for dashed line
Returns
I : 1 if success, NIL otherwise

Definition at line 996 of file SCOLLineEntity.cpp.

◆ SO3LineEntitySetDiffuse()

int SO3LineEntitySetDiffuse ( mmachine  m)

SO3LineEntitySetDiffuse : Set the color of the line (RGBA)

Prototype: fun [SO3_OBJECT I] I

Parameters
SO3_OBJECT: target line entity
I: given color (rgba)
Returns
I : 1 if success, NIL otherwise

Definition at line 439 of file SCOLLineEntity.cpp.

◆ SO3LineEntitySetPoint()

int SO3LineEntitySetPoint ( mmachine  m)

SO3LineEntitySetPoint : Sets the position of an existing point of the line.

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

Parameters
SO3_OBJECT: target line entity
I: index of the point (starting to 0). Last point if NIL.
[FF F] : the position of the point
Returns
I : 1 if success, NIL otherwise

Definition at line 557 of file SCOLLineEntity.cpp.

◆ SO3LineEntitySetPoints()

int SO3LineEntitySetPoints ( mmachine  m)

SO3LineEntitySetPoints : Set all the points of the line in a single call.

Prototype: fun [SO3_OBJECT [[F F F] r1]] I

Parameters
SO3_OBJECT: target line entity
[[FF F] r1]] : points positions. Clear the line if NIL.
Returns
I : 1 if success, NIL otherwise

Definition at line 871 of file SCOLLineEntity.cpp.

Generated by doxygen 1.9.8