jit.gl.material
Generate materials for 3D objects
Description
Produces shaders for high quality rendering that automatically adapt to texture inputs and the number of active lights.
Discussion
This object requires one argument: the name of a drawing context. A named drawing context is a named instance of a jit.window, jit.pwindow, or jit.matrix object that has an instance of the jit.gl.render object associated with it. Additionally it can reference the name of a jit.gl.node sub-context. This value may also be set via the OB3D drawto attribute. If no argument is present, the object is implicitly added to the first valid drawing context or sub-context found in the current patch or by searching up the patcher hierarchy.
Matrix Operator
| Name | IOProc | Planelink | Typelink | Dimlink | Plane | Dim | Type |
|---|---|---|---|---|---|---|---|
| out | n/a | 1 | 1 | 1 | 1 | 1 | char |
More about Matrix Operators
The Jitter MOP
Since the matrix is Jitter's focus, it is not surprising that the majority of Jitter objects fall in this category of Matrix Operators. Every Matrix operator has some number of matrix inputs and some number of matrix outputs. Matrix inputs are referred to by the names "in", "in2", "in3", etc., from left to right, and matrix outputs are referred to by the names "out", "out2", "out3", etc., from left to right--i.e. the names are appended by the input/output number except for the first (leftmost) input and first (leftmost) output which are simply named "in" and "out". We will refer to the input or output name names as the "I/O-name".
Matrix inputs and outputs typically each have their own matrices internally where information is kept. This is necessary because Jitter is an asynchronous framework (i.e. all the matrices don't arrive at all inputs at the same time). Various aspects of matrix inputs and outputs can be set using the command [I/O-name] combined with one of the following suffixes: "_dim" which will set the dimensions of the specified I/O matrix, "_type" which will set the type of the specified matrix, "_planecount" which will set the plane of the specified matrix, or "_name" which will set the name of the specified matrix. There is one special case which does not have an internal matrix and this is the first input "in". This is the case since this special input actually triggers the calculation of the matrix operator, so it doesn't need to be cached until a calulation takes place, unlike the other inputs. Therefore there is no mechanism to set the dim, planecount, type, or name of "in".
Matrix operators accept what we'll refer to as "matrix args"--i.e. [planecount (int)] [ type (symbol)] [dim (int list)] . if these arguments are present, the adapt attribute will be turned off, otherwise it will be turned on. If adapt mode is turned on, each time a matrix is received in the first input, there will also be the equivalent of setting the dim , planecount , and type attributes to that of the input matrix. If the other inputs and outputs are linked to these attributes, this will affect their linked attributes as well. See the "MOP" table to determine which inputs and outputs will be linked to which attributes when adapt mode is turned on. For the leftmost input this is not applicable, and hence all columns are labelled "n/a".
The jit.matrix object is a named matrix which may be used to matrix data storage and retrieval, resampling, and matrix type and planecount conversion operations.
MOP Arguments
planecount[int]
optional
Explicitly sets the number of planes for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.
type[symbol]
optional
Explicitly sets the type of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.
dimensions[list]
optional
Explicitly sets the dimensions of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.
MOP Attributes
adapt[int]
Matrix adaptation flag (default = 0 if matrix arguments are present, otherwise 1) When the flag is set, the jit.matrix object will adapt to the incoming matrix planecount, type, and dimensions.
[in/out]_dim[32 ints]
The matrix data dimensions (default = 1 1)
[in/out]_name[symbol]
The input or output name of the matrix (default = UID)
[in/out]_planecount[int]
The number of planes in matrix input our output data. Except in special cases, this value is equal to the planecount .
[in/out]_type[symbol]
The input or output matrix data type. Except in special cases, this value is equal to type .
outputmode[int]
Output mode (default = 1 (calculate and output matrix))
0 = No output (no calculation)
1 = Calculate and output the matrix
2 = Pass input (no calculation)
3 = Pass output (no calculation)
type[int]
The matrix data type (default = char
Supported data types are char , long , float32 , or float64 .
MOP Messages
bang
Equivalent to the outputmatrix message.
clear
Sets all cell values in a matrix to zero.
exportattrs
Exports an object's current attributes values in XML format. If no filename is specified, a file dialog will open to let you choose a file.
- filename
[symbol]
getattributes
Sends a sequence of lists out the object's right outlet describing the object's attributes, one line per attribute. Each line listing takes the form attribute attribute-name get get-value set foo set-value data-type(s) number-of-values .
getstate
Sends a sequence of lists describing the object's state out the object's right outlet, one line per attribute. Each line listing line takes the form attribute-name attribute-value1 attribute-value2 ... attribute-valueN .
importattrs
Imports attributes specified in XML format to set the object's attributes. If no filename is specified, a file dialog will open to let you choose a file.
- filename
[symbol]
jit_matrix
Handles input for the named matrix. If this messages is received in the left inlet, output is typically triggered. If this message is received in any other inlet, the data is typically cached until the jit_matrix message is received in the left inlet.
- matrix-name
[symbol]
outputmatrix
Sends the matrix out the left outlet.
summary
Sends a sequence of lists describing the object and it attributes and messages out the rightmost outlet of the object. The first output line takes the form summary objectname object-name . The second and third lines describe the number of inlets and outlets for the object in the form summary (matrixinputcount/matrixoutletcount) number-of-(inlets/outlets) . The fourth line describes the matrixoutput in the form summary matrixoutput descriptor planelink planelink-value typelink typelink-value dimlink dimlink-value types data-type(s) . Each attribute for the object is then listed, one attribute per line. Each line listing takes the form summary attribute attribute-name attribute-value1 attribute-value2 ... attribute-valueN .
Attributes
darkness[float]
Material darkness. Only valid when the diffuse shading model is minnaert.
diffuse_model[symbol]
Diffuse shading model
Possible values:
'lambert'
(
Lambertian diffuse shading model
)
'oren_nayer'
(
Oren-Nayer diffuse shading model
)
'toon'
(
Toon diffuse shading model
)
'minnaert'
(
Minnaert diffuse shading model
)
diffuse_size[float]
Diffuse toon component size. Only valid when the diffuse shading model is toon.
diffuse_smooth[float]
Diffuse toon component smoothness. Only valid when the diffuse shading model is toon.
drawto[symbol]
Render context name
fog[symbol]
Fog type
Possible values:
'none'
(
No fog
)
'linear'
(
Linear fog
)
'exp'
(
Exponential fog
)
'exp2'
(
Squared exponential fog
)
heightmap_mode[symbol]
Heightmap mode to use when the heightmap input is in use (default = parallax).
Possible values:
'parallax'
(
Parallax heightmap mode
)
Parallax heightmap mode is used in conjunction with normal mapping to enhance the depth effect by displacing texture coordinates. A normals input is required when using parallax mode.
'vtf'
(
Vertex texture fetch mode
)
Vertex texture fetch mode samples the heightmap texture's first channel (red plane) in the vertex program and displaces the vertex position along its normal by that amount. vtf mode requires texture inputs must be non-rectangular (@rectangle 0).
'vtf_normals'
(
Vertex texture fetch with normals generation mode
)
Vertex texture fetch with normals generation mode is similar to vtf mode but it also regenerates lighting normals for the displaced mesh.
override[int]
Override jit.gl object color material attributes
roughness[float]
Material roughness. Only valid when the diffuse shading model is oren_nayer.
shadow_eps[float]
7.0.0
Shadow epsilon (eps) modifies the shape of shadows, and corrects self-shadowing error (default = 0.2). This value is used when the bound object is a shadow-receiver.
shadow_hard[float]
7.0.0
Adjust shadow hardness (default = 0.7). This value is used when the bound object is a shadow-receiver.
shadow_radius[float]
7.0.0
Adjust shadow blur radius (default = 0.3). This value is used when the bound object is a shadow-receiver.
shadow_soft[float]
7.0.0
Adjust shadow softness (default = 0.3). Overwrites shadow_radius and shadow_hard attributes. This value is used when the bound object is a shadow-receiver.
specular_model[symbol]
Specular shading model
Possible values:
'blinn'
(
Blinn specular shading model
)
'phong'
(
Phong specular shading model
)
'toon'
(
Toon specular shading model
)
'ward'
(
Ward specular shading model
)
'cook_torrance'
(
Cook-Torrance specular shading model
)
specular_size[float]
Specular toon component size. Only valid when the specular shading model is toon.
specular_smooth[float]
Specular toon component smoothness. Only valid when the specular shading model is toon.
type[symbol]
read-only
Material type (a descriptive name of the material).
OB3D Attributes
automatic[int]
Automatic rendering flag (default = 1) When the flag is set, rendering occurs when the associated jit.gl.render object receives a bang message
auto_material[int]
Automatic material attributes flag (default = 1) When the flag is set, and lighting is enabled for the object, the diffuse and ambient material components for the object will be set to the object's color, and the specular and emissive lighting components are disabled.
aux_color[4 floats]
The auxiliary color in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
enable[int]
Enable flag (default = 1) When the flag is set, drawing is enabled.
fog_params[7 floats]
The fog parameters in the form red green blue alpha density start end (default = 0. 0. 0. 0. 0. 0. 0.) The list's color elements should be in the range 0.-1.
layer[int]
Object layer number (default = 0) When in automatic mode, the layer number determines the rendering order (low to high). Objects in the same layer have no guarantee which will be rendered first.
lighting_enable[int]
Lighting enabled flag (default = 0) When the flag is set, lighting is calculated.
mat_ambient[4 floats]
The ambient light material property in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
mat_diffuse[4 floats]
The diffuse light material property in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
mat_emission[4 floats]
The material emission property in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
mat_specular[4 floats]
The specular light material property in the form red green blue alpha (default = 0. 0. 0. 0.) The list elements should be in the range 0.-1.
matfile[symbol]
The Jitter material file to apply (.jitmtl)
name[symbol]
The instance name (default = UID)
shadow_caster[int]
Shadow caster flag (default = 0) When the flag is set, object will cast shadows.
shininess[float]
The material shininess value (default = 16.0) The value should be a float in the range 0.-255.
smooth_shading[int]
Smooth shading flag (default = 0) When the flag is set, smooth shading is used when rendering.
shader[symbol]
The name of the shader to be applied (default = none)
Common Box Attributes
annotation[symbol]
Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.
background[int]: 0
Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.
color[4 floats]
Sets the color for the object box outline.
fontface[int]
Sets the type style used by the object. The options are:
plain
bold
italic
bold italic
Possible values:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
fontname[symbol]
Sets the object's font.
fontsize[float]
Sets the object's font size (in points).
Possible values:
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'
hint[symbol]
Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.
ignoreclick[int]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.
presentation[int]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 0. 0. 0. 0.
Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.
rect[4 floats]
write-only
Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).
size[2 floats]
write-only
Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.
textcolor[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
varname[symbol]
Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.
Messages
(drag)
Drag and drop a Jitter material file (.jitmtl)
ambient_texture
Set ambient texture
- name
[symbol]
(mouse)
Open the materials browser
diffuse_texture
Set diffuse texture
- name
[symbol]
emission_texture
Set emission texture
- name
[symbol]
environment_texture
Set the environment texture. The environment texture can be a jit.gl.texture or a jit.gl.cubemap)
- name
[symbol]
getparamdefault
Get parameter default value
- name
[symbol]
getparamlist
Get list of parameter names
getparamtype
Get parameter type
- name
[symbol]
getparamval
Get the parameter value
- name
[symbol]
glossmap_texture
Set glossmap texture
heightmap_texture
Set heightmap texture
normals_texture
Set the normals texture. The normals texture will add a bump-mapping effect to the material.
- name
[symbol]
open
Open the materials browser
param
Set material parameter value
- name
[symbol]
- values
[list]
reset
Reset shading model and colors
reset_colors
Reset colors to default values
reset_shading_model
Reset shading model to default values
specular_texture
Set specular texture
- name
[symbol]
wclose
Close material browser
OB3D Messages
bang
Equivalent to the draw message.
draw
Draws the object in the named drawing destination. If the matrixoutput attribute is supported and set to 1, the geometry matrices are sent out the object's left outlet.
drawraw
Equivalent to draw with the inherit_all attribute set to 1.
drawimmediate
Equivalent to draw but ignoring any potential renderer setup
import_material
Import a Jitter material file (.jitmtl).
export_material
Export material state as a material file (.jitmtl).
jit_gl_texture
Binds the texture specified by texture-name to this object. Equivalent to setting the texture attribute to texture-name .
- texture-name
[symbol]
get_shader
Open an editor window containing the object's current JXS shader.
See Also
| Name | Description |
|---|---|
| jit.gl.cubemap | Manage a cubemap texture target |
| jit.gl.model | Read and draw various 3D model formats |
| jit.gl.render | Render Jitter OpenGL objects |
| jit.gl.shader | Manage a GL shader |
| jit.gl.texture | Create OpenGL textures |