Simstim

VEX Dictionary

1028 functions in displace · showing the first 200

  1. fitexamplesRemaps a value from one range into another, clamped to the new range.
  2. nearpointsexamplesLists the point numbers nearest to a position, closest first, within a search radius.
  3. noiseexamplesSmooth Perlin-style noise from a position, centred around 0.5.
  4. pcopenexamplesOpens a point cloud query around a position and returns a handle for the other pc functions.
  5. primuvexamplesReads any attribute at an exact parametric (uv) location on a primitive.
  6. xyzdistexamplesFinds the closest spot on another geometry's surface: its distance, primitive and parametric uv.
  7. absComputes the absolute value of an int, float, or vector, per component.
  8. abspathConverts a relative file path to an absolute one, without requiring the file to exist.
  9. acosComputes the inverse cosine (arccosine) of a float or vector, component-wise.
  10. acospiComputes the arccosine of a value divided by pi, for scalars or vectors.
  11. addattribCreates a new attribute of a chosen class (detail, point, vertex, or primitive) with a default value.
  12. adddetailattribCreates a detail (whole-geometry) attribute with a default value and optional transform typing.
  1. addpointCreates a new point at a given position, or as a copy of an existing point, and returns its number.
  2. addpointattribCreates a point attribute with a default value and optional transform-type metadata.
  3. addprimCreates a new primitive, such as a poly, optionally wiring it to given points.
  4. addprimattribCreates a primitive attribute with a default value and optional transform-type metadata.
  5. addvariablenameMaps an attribute name to a local $-style variable name for use in supporting SOPs.
  6. addvertexAppends a new vertex to a primitive, connects it to a given point, and returns the new vertex's index.
  7. addvertexattribCreates a vertex attribute with a default value and optional transform-type metadata.
  8. addvisualizerAppends a reference to another node's visualizers onto the visualizer attribute stored at a geometry's detail level.
  9. agentchannelcountCounts how many channels an agent primitive's animation rig defines.
  10. agentchannelnamesLists every channel name defined by the rig of an agent primitive.
  11. agentchannelvalueReads the current value of one channel in an agent primitive's rig.
  12. agentchannelvaluesReads the current values of every channel in an agent primitive's rig at once.
  13. agentclipcatalogLists every animation clip that has been loaded into an agent primitive's definition.
  14. agentclipchannelLocates a named channel inside one of an agent's animation clips and gives back its index.
  15. agentclipchannelnamesLists the channel names contained in one of an agent primitive's animation clips.
  16. agentcliplayerblendCombines a set of values, weighting them by the layer weights and hierarchy of an agent's animation.
  17. agentcliplayersamplelocalEvaluates and mixes the layered clips on an agent, giving local-space transforms for its rig.
  18. agentcliplayersampleworldEvaluates and mixes the layered clips on an agent, giving world-space transforms for its rig.
  19. agentcliplengthReports the duration in seconds of a named animation clip on an agent primitive.
  20. agentclipnamesLists the animation clips currently assigned to an agent primitive.
  21. agentclipsampleSamples one channel's value from an agent's animation clip at a given time.
  22. agentclipsamplelocalSamples an agent's clip at a given time, returning local-space rig transforms.
  23. agentclipsamplerateReads the sample rate stored for one of the animation clips on an agent primitive.
  24. agentclipsampleworldSamples an agent's clip at a given time, returning world-space rig transforms.
  25. agentclipstarttimeReads when, in seconds, one of the animation clips on an agent primitive begins.
  26. agentcliptimesLists, for every animation clip on an agent primitive, the playback time it is currently at.
  27. agentcliptransformgroupsLists the transform groups used by an agent primitive's currently assigned clips.
  28. agentclipweightsLists how strongly each animation clip currently assigned to an agent primitive is weighted in the blend.
  29. agentcollisionlayersLists the collision layer names defined on an agent primitive.
  30. agentcurrentlayersLists which layers are currently active on an agent primitive, by name.
  31. agentfindclipLooks up a clip by name in an agent primitive's definition and returns its index.
  32. agentfindlayerLooks up a layer by name in an agent primitive's definition and returns its index.
  33. agentfindtransformgroupLooks up a transform group by name in an agent primitive's definition and returns its index.
  34. agentlayerbindingsReports the rig transform that every shape within one of an agent's layers binds to.
  35. agentlayersLists every layer loaded into the definition of an agent primitive.
  36. agentlayershapesLists shape names referenced by an agent's layer for a given shape type or transform.
  37. agentlocaltransformGets one rig transform's matrix relative to its parent, as the agent primitive is posed right now.
  38. agentlocaltransformsReads the current transforms of all bones in an agent primitive's rig, expressed in local space.
  39. agentmetadataReads the metadata dictionary stored in an agent primitive's shared definition.
  40. agentrestlocaltransformReads the local-space rest-pose transform of one joint in an agent's rig.
  41. agentrestworldtransformReads the world-space rest-pose transform of one joint in an agent's rig.
  42. agentrigchildrenLists the direct child transforms of a given transform in an agent's rig.
  43. agentrigfindLooks up a transform by name in the rig of an agent primitive and returns its index.
  44. agentrigfindchannelLooks up a channel by name in the rig of an agent primitive and returns its index.
  45. agentrigparentLooks up which transform is the parent of a given rig transform, returning -1 at the root.
  46. agentsolvefbikRuns a full-body IK solve on an agent's skeleton to reach target transforms.
  47. agenttransformcountCounts the transforms, or bones, that make up the rig of an agent primitive.
  48. agenttransformgroupmemberChecks whether a given rig transform belongs to a named transform group.
  49. agenttransformgroupmemberchannelChecks whether a rig channel belongs to the transform group at a given index in an agent's definition.
  50. agenttransformgroupsLists the transform group names defined in an agent's rig.
  51. agenttransformgroupweightReturns a transform's blend weight within a given transform group, or zero if absent.
  52. agenttransformnamesLists the names of all transforms making up the rig of an agent primitive.
  53. agenttransformtolocalTurns an array of world-space transforms into local-space ones for an agent's rig.
  54. agenttransformtoworldTurns an array of local-space transforms into world-space ones for an agent's rig.
  55. agentworldtransformGets one rig transform's matrix accumulated through all its parents, as the agent primitive is posed right now.
  56. agentworldtransformsReads the current transforms of all bones in an agent primitive's rig, expressed in world space.
  57. albedoEstimates the fraction of light a bsdf reflects, given an outgoing view direction.
  58. ambientGives the shading color contributed by the scene's ambient light sources.
  59. anoiseGenerates cellular "alligator" noise at a 3D position, similar in look to Worley noise.
  60. appendAdds a value or array of values onto the end of an array or string.
  61. areaEstimates, in pixels, the shading area of the micropolygon surrounding a derivable variable like P.
  62. argsortReturns the indices that would sort an array's values into increasing order.
  63. arrayBuilds an array out of the given arguments; wrap it in a type cast such as vector[]() to type it correctly.
  64. ashikhminBuilds an anisotropic specular bsdf with independent highlight sizes along two tangent directions.
  65. asinComputes the inverse sine (arcsine) of a float or vector, component-wise.
  66. asinpiComputes the arcsine of a value divided by pi, for scalars or vectors.
  67. assert_enabledReports whether VEX assertions are turned on via the HOUDINI_VEX_ASSERT environment variable.
  68. assignUnpacks a vector or matrix's components directly into separate float variables efficiently.
  69. atanComputes the inverse tangent of a value, or of y/x, per component for vectors.
  70. atan2Computes the angle whose tangent is y/x, using both signs to pick the right quadrant.
  71. atan2piComputes the angle whose tangent is y/x, then divides the result by pi, giving -1 to 1.
  72. atanpiComputes the inverse tangent of a value, or of y/x, divided by pi, for scalars or vectors.
  73. atofParses a string into a floating-point number, ignoring surrounding whitespace and supporting exponents.
  74. atoiParses a string into an integer, optionally using a specified numeric base.
  75. attenComputes simple distance attenuation as attenuation divided by attenuation plus distance.
  76. attribReads a point, primitive, vertex, or detail attribute's value with the class chosen at runtime.
  77. attribclassReturns which class (detail, primitive, point, or vertex) a named attribute belongs to.
  78. attribdataidReturns an attribute's internal data id, useful for caching acceleration structures across cooks.
  79. attribsizeGives an attribute type's tuple size, for example the number of components in a vector.
  80. attribtypeReturns a numeric code identifying an attribute's data type, such as float or string.
  81. attribtypeinfoReads the transform-related metadata string describing how an attribute should be transformed.
  82. avgComputes the average of one or more numeric arguments, or of a vector's components.
  83. blackbodyDerives an incandescent black body's CIE XYZ color from a temperature and a luminance.
  84. blinnBuilds a Blinn specular bsdf, or directly evaluates Blinn shading for a normal and view vector.
  85. blinnBRDFComputes the Blinn BRDF value for given light, normal, and view vectors, for use in custom illuminance loops.
  86. bouncelabelReturns the text label associated with a given bounce or shading-component bitmask.
  87. bouncemaskConverts a space-separated list of shading-component labels into a bounce bitmask.
  88. bumpmapSamples a texture file's bump derivatives directly; superseded by Du/Dv on texture.
  89. bumpmapASamples the alpha channel's bump derivatives from a texture file; superseded by Du/Dv on texture.
  90. bumpmapBSamples the blue channel's bump derivatives from a texture file; superseded by Du/Dv on texture.
  91. bumpmapGSamples the green channel's bump derivatives from a texture file; superseded by Du/Dv on texture.
  92. bumpmapLSamples the luminance channel's bump derivatives from a texture file; superseded by Du/Dv on texture.
  93. bumpmapRSamples the red channel's bump derivatives from a texture file; superseded by Du/Dv on texture.
  94. cbrtComputes the cube root of a float or vector, component-wise.
  95. ceilRounds a float or vector up to the nearest integer, component-wise.
  96. chEvaluates a node channel or parameter at the current or a given time and returns its value.
  97. ch2Evaluates a matrix2-type parameter's component channels together and returns them as a matrix2.
  98. ch3Evaluates a matrix3-type parameter's component channels together and returns them as a matrix3.
  99. ch4Evaluates a 4x4 matrix-type parameter's component channels together and returns them as a matrix.
  100. chdictEvaluates a parameter holding a key-value dictionary and gives back its contents as a dict.
  101. chexprEvaluates a channel using a substituted segment expression, useful for extracting slope or acceleration.
  102. chexprfSubstitutes a segment expression into a channel and evaluates it at a specific frame.
  103. chexprtSubstitutes a segment expression into a channel and evaluates it at a specific time in seconds.
  104. chfEvaluates a float channel or parameter at the current or a given time.
  105. chiEvaluates an integer channel or parameter at the current or a given time.
  106. chiangBuilds a bsdf implementing the Chiang physically based hair and fur shading model, for curve geometry.
  107. chiang_furBuilds a bsdf extending the Chiang hair model with a medulla term for thick fur.
  108. chidResolves a channel path into an operator id, parameter index, and vector index, or validates them.
  109. chopReads a sample from a named CHOP node's channel, interpolating for fractional sample indices.
  110. choplocalReads a sample from a CHOP node's local transform channel at a given index.
  111. choplocaltReads a CHOP node's local transform channel at a given sample and evaluation time.
  112. choptReads a CHOP node's channel at a given sample index and evaluation time.
  113. chpEvaluates a vector4 channel or parameter, combining its component channels, at the current or a given time.
  114. chprim_clearClears all keyframes from a channel primitive identified by a geometry handle and index.
  115. chprim_destroykeyRemoves the keyframe at a specific time from a channel primitive on a geometry handle.
  116. chprim_endReports when a channel primitive's animation ends, in seconds.
  117. chprim_evalSamples the value of a channel primitive at a specified time in seconds.
  118. chprim_insertkeyInserts a new keyframe at a specified time into a channel primitive.
  119. chprim_keycountCounts the number of keyframes stored in a channel primitive.
  120. chprim_keytimesLists, in seconds, when each keyframe occurs within a channel primitive.
  121. chprim_keyvaluesLists the value of every keyframe stored in a channel primitive.
  122. chprim_lengthReports how many seconds long a channel primitive's timeline runs.
  123. chprim_setkeyaccelModifies the acceleration already set on a channel-primitive key, optionally just the in or out half.
  124. chprim_setkeyslopeAdjusts the in or out slope of an existing key on a channel primitive.
  125. chprim_setkeyvalueOverwrites the value stored at an existing key on a channel primitive.
  126. chprim_startReports when a channel primitive's animation begins, in seconds.
  127. chrConverts a single Unicode codepoint into its UTF-8 encoded string form.
  128. chrampSamples a ramp channel or parameter at a normalized position, optionally at a set time.
  129. chrampderivComputes the slope of a ramp channel at a given position along its curve.
  130. chsEvaluates a string channel or parameter and returns its current text value.
  131. chsopReads an operator-path channel or parameter and returns the target node's path.
  132. chsrawReturns a channel's raw expression text without evaluating it.
  133. chuEvaluates a channel or two-component parameter and returns it as a vector2.
  134. chvEvaluates a channel or vector parameter, by name or operator id, returning a vector.
  135. cksplineInterpolates a Catmull-Rom spline through explicit position and value key pairs at a given t.
  136. clampConstrains a number or vector so each component stays between a minimum and maximum.
  137. clipTrims a line segment, in place, against a plane or an axis-aligned bounding box.
  138. colormapSamples a filtered color, with optional alpha, from an image file at uv coordinates.
  139. combinelocaltransformBuilds a world transform from local and parent transforms, honoring a scale-inheritance mode.
  140. computenormalComputes a normal in shading contexts; in SOP context, it instead decides if normals get recomputed.
  141. concatJoins multiple strings into one, faster than repeated plus-operator concatenation for 3 or more.
  142. coneBuilds a cone-shaped specular reflectance lobe around a given direction and angle.
  143. cosComputes the cosine of a float or each component of a vector.
  144. coshComputes the hyperbolic cosine of a float or each component of a vector.
  145. cospiComputes the cosine after first multiplying the input by pi.
  146. cracktransformBreaks a transform matrix into translate, rotate, scale, and shear components around a pivot.
  147. create_cdfBuilds a cumulative distribution function array from an input probability density function array.
  148. create_pdfBuilds a probability density function array from a set of input weight values.
  149. cregioncapturetransformReads the capture transform of a Capture Region SOP without cooking the node.
  150. cregiondeformtransformReads the deform transform of a Capture Region SOP without cooking the node.
  151. cregionoverridetransformReads a Capture Region SOP's capture or deform transform, chosen by the global override flag.
  152. crossComputes the cross product of two 3D vectors.
  153. csplineInterpolates a Catmull-Rom spline through evenly spaced key values across a 0 to 1 range.
  154. ctransformConverts a color triplet from one color space, such as RGB or HSV, into another.
  155. curlgxnoiseGenerates a divergence-free 3D vector field by taking the curl of simplex noise.
  156. curlgxnoise2dGenerates a divergence-free 2D vector field, confined to the XY plane, from simplex noise curl.
  157. curlnoiseGenerates a divergence-free 3D vector field from the curl of two Perlin noise fields.
  158. curlnoise2dGenerates a 2D, divergence-free noise field in the XY plane from Perlin noise curl.
  159. curlxnoiseGenerates a divergence-free 3D vector field from the curl of two simplex noise fields.
  160. curlxnoise2dGenerates a 2D, divergence-free noise field in the XY plane from simplex noise curl.
  161. curvearclenMeasures the curve length spanned between two parametric coordinates along a curve built from an array of control point positions.
  162. cvex_bsdfBuilds a custom BSDF by pairing separate CVEX shaders for evaluation and sampling.
  163. cwnoiseComputes Chebyshev-distance cellular noise at a position, returning distances to nearby seed points.
  164. decodeRecovers a string previously packed into a valid variable name by encode.
  165. decodeattribRecovers a string previously packed into a valid attribute or group name by encodeattrib.
  166. decodeparmRecovers a string previously packed into a valid node parameter name by encodeparm.
  167. decodeutf8Splits a UTF-8 string into an array of integer Unicode codepoints.
  168. degreesConverts a radian value, or each vector component, into degrees.
  169. depthmapReads the camera-to-pixel distance stored in a rendered z-depth image, unfiltered.
  170. detailFetches the value stored in a whole-geometry (detail) attribute of a piece of geometry.
  171. detailattribReads a detail attribute's value and reports, via an output flag, whether the read succeeded.
  172. detailattribsizeReturns how many components a geometry's detail attribute holds, like attribsize for other classes.
  173. detailattribtypeReturns the data-type code of a detail attribute, like attribtype for other classes.
  174. detailattribtypeinfoReturns extra type-info metadata for a detail attribute, like attribtypeinfo for other classes.
  175. detailintrinsicReads a built-in intrinsic value from a geometry's detail, such as bounds or count.
  176. determinantComputes the determinant of a 2x2, 3x3, or 4x4 matrix.
  177. diagExtracts a matrix's diagonal as a vector, or builds a diagonal matrix from one.
  178. diagonalizesymmetricDecomposes a symmetric matrix into an orthogonal matrix and its diagonal eigenvalues.
  179. diffuseBuilds a diffuse bsdf lobe, or in older vector forms computes Lambertian or Oren-Nayar diffuse illumination from a normal.
  180. diffuseBRDFComputes the diffuse lighting term for reuse inside a custom illuminance loop.
  181. dihedralComputes a rotation, as a matrix or quaternion, that aligns one vector with another.
  182. distanceComputes the straight-line distance between two points; use distance2 to skip the square root.
  183. distance2Computes the squared distance between two points, cheaper than distance when only comparing.
  184. distance_pointlineComputes the shortest distance from a point to an infinite line through a point and direction.
  185. distance_pointrayComputes the shortest distance from a point to a ray starting at a point and direction.
  186. distance_pointsegmentComputes the shortest distance from a point to a finite segment between two endpoints.
  187. dotComputes the dot product of two vectors, summing paired component products.
  188. dsmpixelReads every deep record of a named channel at a single pixel in a deep shadow or camera map, returning the count.