jit.geom.displace
Displaces a surface using a height field
Description
jit.geom.displace displaces surface geometry based on a height field geometry matrix that can be sampled in different ways. The height field matrix is provided via the secondary inlet.
Attributes
mid[float]
The sampled value that is treated as no displacement by the object. Sampled values below this threshold will result in a negative displacement.
sampler[symbol]
Describes how to sample the height field matrix. The default is "nearest".
Possible values:
'nearest'
(
Nearest neighbor sampling
)
Uses the nearest neighbor when sampling the height field matrix.
'bilinear'
(
Bilinear neighbor sampling
)
Takes an interpolated value from the texture coordinate's neighboring texels in the height field matrix.
strength[float]
The strength of the displacement. The final displacement is calculated by offseting by mid and then scaling by this value. A negative strength can be used to invert the displacement.
tex_coord_mode[symbol]
Describes where the texture coordinates used to sample the height field should come from. The default is "auto".
Possible values:
'auto'
(
Automatically determine what texture coordinates to use
)
If the surface geometry has texture coordinates, they will be used. Otherwise, position will be used.
'position'
(
Use position to generate texture coordinates
)
The object will generate texture coordinates based on the positions relative to the object bounding box.
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
See Also
| Name | Description |
|---|---|
| jit.geom.dimples | |
| jit.geom.normalize | |
| jit.geom.twist | |
| jit.geom.waves |