Members
(constant) CREEPING_FULL :number
- Source:
Possible value for usesCreeping Uses creeping for all possible teleportations, if the user did not define the creeping function, the computation is done with a binary search
Type:
- number
(constant) CREEPING_OFF :number
- Source:
Possible value for usesCreeping No creeping is used
Type:
- number
(constant) CREEPING_STRICT :number
- Source:
Possible value for usesCreeping Only the creeping defined by the user are used
Type:
- number
(constant) KEYBOARD_BINDINGS
- Source:
Keyboard bindings. Each main entry correspond to a keyboard type (American, French, etc). KeyCode are replaced by Key (as KeyCode are now deprecated). To each key is associated an action
(constant) LEFT :number
- Source:
ID for the left side (in VR / Stereo)
Type:
- number
(constant) RIGHT :number
- Source:
ID for the right side (in VR / Stereo)
Type:
- number
Methods
bind(scope, fn) → {function}
Transform a method attached to an object into a function.
Parameters:
| Name | Type | Description |
|---|---|---|
scope |
Object | the object on which the method is called |
fn |
function | the method to call |
Returns:
- Type
- function
complement(shape) → {ComplementShape}
Return the complement of the given shape.
The goal is a to have behavior similar to union and intersection.
Parameters:
| Name | Type | Description |
|---|---|---|
shape |
Shape | the shape to invert |
Returns:
the complement of the given shape.
- Type
- ComplementShape
intersection()
The intersection of an arbitrary number of shapes
pathTracerWrap(material, params) → {PathTracerWrapMaterial}
Wrap the material into another material handling the Phong model
Parameters:
| Name | Type | Description |
|---|---|---|
material |
Material | the material defining the ambient color of the Phong model |
params |
Object | the parameters of the Phong model |
Returns:
- the wrapped material.
phongWrap(material, params) → {PhongWrapMaterial}
Wrap the material into another material handling the Phong model
Parameters:
| Name | Type | Description |
|---|---|---|
material |
Material | the material defining the ambient color of the Phong model |
params |
Object | the parameters of the Phong model |
Returns:
- the wrapped material.
- Type
- PhongWrapMaterial
proj2klein(point)
Parameters:
| Name | Type | Description |
|---|---|---|
point |
Point |
safeString(str) → {string}
Replace all the special characters in the string by an underscore
Parameters:
| Name | Type | Description |
|---|---|---|
str |
string |
Returns:
- Type
- string
specifyRenderer(rendererClass, shader1, shader2) → {GeomRenderer}
- Source:
Take a generic renderer class and return the class specific for a geometry
Parameters:
| Name | Type | Description |
|---|---|---|
rendererClass |
AbstractRenderer | the generic renderer |
shader1 |
string | the first part of geometry dependent shader |
shader2 |
string | the second part of geometry dependent shader |
Returns:
- the renderer build for the suitable geometry
- Type
- GeomRenderer
specifyThurston(thurstonClass, shader1, shader2) → {GeomThurston}
- Source:
Take a generic Thurston class and return the class specific for a geometry
Parameters:
| Name | Type | Description |
|---|---|---|
thurstonClass |
Thurston | ThurstonLite | ThurstonVR | the generic Thurston class |
shader1 |
string | the first part of geometry dependent shader |
shader2 |
string | the second part of geometry dependent shader |
Returns:
- the Thurston class build for the suitable geometry
- Type
- GeomThurston
union()
The union of an arbitrary number of shapes The function takes a bunch of shapes The last argument (if not a shape) are the parameters of the union
wrap(wrap, shape) → {WrapShape}
- Source:
Wrap the given shape
The goal is a to have behavior similar to union and intersection.
Parameters:
| Name | Type | Description |
|---|---|---|
wrap |
Shape | the wrap |
shape |
Shape | the shape to wrap |
Returns:
the wrapped shape
- Type
- WrapShape