Oink
Nodes

ReadVFX

ReadVFX node.

raw .md
NodeReadVFX
Type idOC_N_readvfx
Menu3D › ReadVFX
Nuke classnone: saved in .nk files as an Oink node
Codeopencomp_core/nodes/three_d/read_vfx.py

ReadVFX properties

Inputs and outputs

PortNameType
input 0scenescene
input 1matimage
output 0scenescene

Knobs

Panel tab Readvfx, in panel order.

KnobLabelTypeDefaultRange / valuesNuke knobDescription
filefilefile
mesh_filerest meshfileRest mesh (.vfxm); empty = <stem>_restmesh.vfx next to the file
infoinfotext
frame_offsetframe offsetfloat0-1000 to 1000 (integer)
retimefpsmenuframesframes (frames (1:1)), seconds (seconds (file fps))
beforebeforemenuHOLDHOLD (hold), LOOP (loop), BOUNCE (bounce), BLACK (black)
afteraftermenuHOLDHOLD (hold), LOOP (loop), BOUNCE (bounce), BLACK (black)
units_scaleunits scalefloat10.001 to 100Multiplies the cache's positions (0.01 = cm to m)
displaydisplaymenuproxyproxy, full
proxy_pointsproxy pointsfloat2000001000 to 5000000 (integer)
viewer_point_sizeviewer point sizefloat21 to 20
render_pointsrender pointsfloat20000000 to 20000000 (integer)Most points rendered (0 = all)
max_trianglesmax trianglesfloat100000000 to 50000000 (integer)Instanced rest meshes: instances beyond this are dropped (0 = all)
point_sizepoint sizefloat0.010 to 1Point radius in scene units (renders)
use_pscaleuse pscalebooltrue
splat_displaydisplay asmenuautoauto (auto (splats if scale3)), splats, points
splat_colorspacesplat colourmenusRGBsRGB (sRGB (3DGS)), linear
viewer_splatsviewer splatsfloat30000001000 to 20000000 (integer)Most splats sent to the 3D viewer (the most visible ones)
color_bycolor bytextautoauto, none, Cd, speed, id, pscale, piece, value, height, or a channel
auto_rangeauto rangebooltrue
color_mincolor minfloat0-100 to 100
color_maxcolor maxfloat1-100 to 100
display_colordisplay colorcolour ×31, 1, 10 to 1
volume_modevolumemenuautoauto, surface (surface (level set)), density
volume_gridgridtextempty = first grid
volume_thresholdthresholdfloat0.050 to 10
volume_drawviewer volumemenuvolumevolume (volume (ray-marched)), points
volume_qualityqualityfloat10.1 to 43D viewer ray-march samples per voxel (halved while orbiting)
surface_looksurface lookmenuwaterwater, solid
water_colorwater colorcolour ×30.45, 0.8, 0.90 to 1Light left after crossing a tenth of the cache's size of water
density_scaledensityfloat10 to 100Fog extinction per scene unit = value x density
volume_shadowshadowfloat10 to 10Fog self-shadowing toward the light (0 = unlit)
emission_gridemission gridtextGrid that glows (fire ramp); empty = temperature / heat / flame if present, - = none
emission_intensityemissionfloat10 to 20
projectionmat projectionmenuboxoff, box (box (triplanar)), planar XY, planar XZ, planar YZ, spherical, cylindricalHow the mat input's texture maps onto caches without UVs (level sets, particles), in the cache's object space
projection_scaleprojection scalefloat10.001 to 10Texture size: 1 = once across the cache's largest side (its first frame), centred on the cache each frame; 0.25 = four repeats
xform_ordertransform ordermenuSRTSRT, STR, RST, RTS, TSR, TRS
rot_orderrotation ordermenuZXYXYZ, XZY, YXZ, YZX, ZXY, ZYX
translatetranslatevector ×30, 0, 0-100 to 100
rotaterotatevector ×30, 0, 0-180 to 180
scalingscalevector ×31, 1, 10 to 10
uniform_scaleuniform scalefloat10 to 10
skewskewvector ×30, 0, 0-1 to 1
pivot_translatepivot translatevector ×30, 0, 0-100 to 100
pivot_rotatepivot rotatevector ×30, 0, 0-180 to 180

Other knobs (Python, .nk and the assistant; not on the panel)

KnobLabelTypeDefaultRange / valuesNuke knobDescription
gl_colorViewer Controls Colorfloat ×30, 0, 00 to 1
postage_stamp_frameStatic Frameint1-2147483648 to 2147483647
lifetimeStartLifetime Startint0-2147483648 to 2147483647
lifetimeEndLifetime Endint100-2147483648 to 2147483647
useLifetimeUse Lifetimebooleanfalse
cachedCachedbooleanfalse
bookmarkBookmarkbooleanfalse
dope_sheetDope Sheetbooleanfalse
clone_groupClone Groupstring
link_sourceLink Sourcestring
link_overridesLink Overridesstring
split_viewsSplit Viewsstring
channel_listChannelsstring

Nuke equivalent

No Nuke class. In a .nk file this node is written as an Oink node that Nuke will not recognise.

GeoExport

GeoExport node.

ReadSplat

ReadSplat node.

On this page

Inputs and outputsKnobsOther knobs (Python, .nk and the assistant; not on the panel)Nuke equivalent