The elements of this group grant access to any RealFlow node of your scene. You can choose whether you want to get the nodes individually, e.g. by name, or all nodes of a kind like emitters or daemons, or even by the current selection. Node groups are stored as arrays and a "For" node is required to loop through them. It is also possible to manage the nodes' export resources.
Additionally, this class contains many RealWave-related nodes. A very interesting method is to convert a RealWave surface into a height field and save it as 32-bit image. You will also find nodes for manipulating RealWave surfaces.
Nodes
Name | Description |
---|---|
ArrayRealFlowNodeConcat | This node concatenates the inputs 'array0' and 'array1' into a single 'out' array. |
ArrayRealFlowNodeConstant | This node returns a constant array. |
ArrayRealFlowNodeFilterByMask | This node returns the elements of the input 'array' at positions specified by the 'mask' parameter. |
ArrayRealFlowNodeFindAllElementIndices | This node returns all positions in the input 'array', which fit to the input 'element' values. |
ArrayRealFlowNodeFindElement | This node returns the first position of appearance of the input 'element' within the input 'array'. If the array does not contain the element, -1 is returned. |
ArrayRealFlowNodeInsertElement | This node inserts all elements from the 'element' input into the input 'array' at the position specified by 'position'. If 'position' is equal or lower than 0 then the elements are inserted at the beginning of the array. If 'position' is greater or equal than the inputs 'array' size, elements are appended at the end. |
ArrayRealFlowNodeMix | This node creates an output array based on the two inputs 'array0' and 'array1' and the input mask. If the mask value equals 0 then the value of 'array0' is used, if the mask value is 1 the value of 'array1' is used. |
ArrayRealFlowNodePushElement | This node appends all the elements from the 'element' at the end of the input 'array'. |
ArrayRealFlowNodeRemoveElement | This node removes all elements of the 'by_value' from the input 'array'. The returned mask has the same size as the input 'array' and is set to 0 at removed positions. |
ArrayRealFlowNodeRemoveIndex | This node removes all input array positions by the 'index' input. |
ArrayRealFlowNodeRemoveRepeatedElements | This node removes all repetitions of elements from the input 'array'. The 'new_to_old' array can be used as an 'index' input for a GetArrayElement-Node to restore the original array. The returned mask has the same size as the input 'array' and is set to 0 at removed positions. |
ArrayRealFlowNodeResize | This node resizes the input 'array'. If the result is bigger than the input array, the last value is repeated accordingly. |
ArrayRealFlowNodeReverse | This node reverses the order of the input 'array'. |
ArrayRealFlowNodeSlice | This node returns an array containing the range of the input 'array' from the 'first' position with the given input 'size'.Thus, the output array is a subarray or slice of the input. |
GetAllCameras | This node returns all the Camera nodes in the scene. |
GetAllDaemons | This node returns all the Daemon nodes in the scene. |
GetAllDyversoDomains | This node returns all the DyversoDomain nodes in the scene. |
GetAllDyversoEmitters | This node returns all the DyversoEmitter nodes in the scene. |
GetAllHybridoBubbles | This node returns all the HybridoBubble nodes in the scene. |
GetAllHybridoDomains | This node returns all the HybridoDomain nodes in the scene. |
GetAllHybridoEmitters | This node returns all the HybridoEmitter nodes in the scene. |
GetAllHybridoFoams | This node returns all the HybridoFoam nodes in the scene. |
GetAllHybridoMeshes | This node returns all the HybridoMeshe nodes in the scene. |
GetAllHybridoMeshes_VDB | This node returns all the HybridoMeshe nodes in the scene. |
GetAllHybridoMists | This node returns all the HybridoMist nodes in the scene. |
GetAllHybridoSplashAndFoams | This node returns all the HybridoSplashAndFoam nodes in the scene. |
GetAllHybridoSplashs | This node returns all the HybridoSplash nodes in the scene. |
GetAllHybridoWaterLines | This node returns all the HybridoWaterLine nodes in the scene. |
GetAllHybridoWetAndFoams | This node returns all the HybridoWetAndFoam nodes in the scene. |
GetAllHybridoWets | This node returns all the HybridoWet nodes in the scene. |
GetAllIdocs | This node returns all the Idoc nodes in the scene. |
GetAllMultiBodies | This node returns all the MultiBodie nodes in the scene. |
GetAllMultiJoints | This node returns all the MultiJoint nodes in the scene. |
GetAllMultiServoPosAngulars | This node returns all the MultiServoPosAngular nodes in the scene. |
GetAllMultiServoPosLinears | This node returns all the MultiServoPosLinear nodes in the scene. |
GetAllMultiServoVelAngulars | This node returns all the MultiServoVelAngular nodes in the scene. |
GetAllMultiServoVelLinears | This node returns all the MultiServoVelLinear nodes in the scene. |
GetAllNodeExportResourceCheckOptions | This node returns all the export resource check options allowed for the input 'resource id'. |
GetAllNodeExportResourceOptions | This node returns all the export resource options allowed for the input 'resource id'. |
GetAllNodeExportResources | This node returns all the export resource identifiers and descriptions. It is especially useful in combination with the rest of the 'Get/SetNodeExportResource' nodes. |
GetAllObjects | This node returns all the Object nodes in the scene. |
GetAllParticleLegacyMeshes | This node returns all the ParticleLegacyMeshe nodes in the scene. |
GetAllParticleMeshes | This node returns all the ParticleMeshe nodes in the scene. |
GetAllParticleMeshes_VDB | This node returns all the ParticleMeshe nodes in the scene. |
GetAllRealFlowGroups | This node returns all the RealFlowGroup nodes in the scene. |
GetAllRealFlowNodes | This node returns all the current scene nodes. |
GetAllSplineNodes | This node returns all the SplineNode nodes in the scene. |
GetAllStandardEmitters | This node returns all the StandardEmitter nodes in the scene. |
GetArrayRealFlowNodeElement | This node returns the elements of the input 'array' at positions specified by the 'index' parameter. |
GetCamera | This node returns the scene node that matches exactly the input 'name'. |
GetDaemon | This node returns the scene node that matches exactly the input 'name'. |
GetDyversoDomain | This node returns the scene node that matches exactly the input 'name'. |
GetDyversoEmitter | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoBubbles | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoDomain | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoEmitter | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoFoam | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoMesh | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoMesh_VDB | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoMist | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoSecondaryEmitter | This node gets the RealFlow Hybrido secondary emitter. |
GetHybridoSplash | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoSplashAndFoam | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoWaterLine | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoWet | This node returns the scene node that matches exactly the input 'name'. |
GetHybridoWetAndFoam | This node returns the scene node that matches exactly the input 'name'. |
GetIdoc | This node returns the scene node that matches exactly the input 'name'. |
GetLinearVelocity | Returns the linear velocity of the input 'object' at the current moment. |
GetMatchingCameras | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingDaemons | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingDyversoDomains | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingDyversoEmitters | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoBubbles | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoDomains | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoEmitters | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoFoams | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoMeshes | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoMeshes_VDB | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoMists | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoSplashAndFoams | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoSplashs | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoWaterLines | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoWetAndFoams | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingHybridoWets | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingIdocs | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingMultiBodies | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingMultiJoints | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingMultiServoPosAngulars | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingMultiServoPosLinears | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingMultiServoVelAngulars | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingMultiServoVelLinears | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingObjects | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingParticleLegacyMeshes | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingParticleMeshes | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingParticleMeshes_VDB | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingRealFlowGroups | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingRealFlowNodes | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingSplineNodes | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMatchingStandardEmitters | This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'. |
GetMultiBody | This node returns the scene node that matches exactly the input 'name'. |
GetMultiBodyInfo | This node returns information about the input multi-body. |
GetMultiBodyTransformation | This node returns an array of transformation matrices for all items within a MultiBody. |
GetMultiJoint | This node returns the scene node that matches exactly the input 'name'. |
GetMultiServoPosAngular | This node returns the scene node that matches exactly the input 'name'. |
GetMultiServoPosLinear | This node returns the scene node that matches exactly the input 'name'. |
GetMultiServoVelAngular | This node returns the scene node that matches exactly the input 'name'. |
GetMultiServoVelLinear | This node returns the scene node that matches exactly the input 'name'. |
GetNodeExportResourceCheckOptionValue | This node returns the state of the input/export resource check options. |
GetNodeExportResourceIdFromDescription | This node returns all the information related to an export resource of the input 'node'. If the resource does not exist and the 'exists' output is not connected, an error message is displayed. |
GetNodeExportResourceInfo | This node returns all the information related to an export resource of the input 'node'. If the resource does not exist and the 'exists' output is not connected, an error message is displayed. |
GetNodeName | This node returns the input 'node' name. |
GetNodeParameter | This node returns the value of the input 'node' parameter. |
GetNodeParameterType | This node returns the value of the input 'node' parameter. |
GetObject | This node returns the scene node that matches exactly the input 'name'. |
GetParticleLegacyMesh | This node returns the scene node that matches exactly the input 'name'. |
GetParticleMesh | This node returns the scene node that matches exactly the input 'name'. |
GetParticleMesh_VDB | This node returns the scene node that matches exactly the input 'name'. |
GetRealFlowGroup | This node returns the scene node that matches exactly the input 'name'. |
GetRealFlowNode | This node returns the scene node that matches exactly the input 'name'. |
GetRealFlowNodeGlobalVariable | This node returns a reference to previously stored variables in global memory (using the SetGlobalVariable-Nodes). |
GetRealWaveAsHeightfieldImage | Returns a greyscale, 32bit image, containing the realwave surface as a heightfield. The search radius defines the area to be searched for neighboring polygons. For non-choppy surfaces, the radius may be low. For choppy-surfaces use high values (around 1.0), but take note, those values may result in poor performance, since choppy surfaces are converted to plain heightfields. The epsilon value describes an offset, which is reducing artifacts on the border. If polygons on the border are set to minimal height, increase this value. |
GetRealWaveHeightAt | Determines the height of a RealWave surface at the given input point (x,y,z) - the y coordinate is not considered and thus, may be 0. Returns the corresponding point on the surface (x,h,z). If the surface is not existing at the spppecified points position, the original, unchanged point (x,y,z) is returned. |
GetRealWaveInfo | This node returns information about the RealWave. |
GetRealWaveMesh | This object returns a reference to the RealWave mesh. |
GetSelectedNodes | This node returns the selected nodes in the scene. |
GetSplineNode | This node returns the scene node that matches exactly the input 'name'. |
GetStandardEmitter | This node returns the scene node that matches exactly the input 'name'. |
GetTransformation | This node returns all transformations of the input 'node'. |
NodeEnableExportData | This node changes the input 'node' active state for exporting data. |
NodeExportDataIsActive | This node returns the input 'node' active state for exporting data. |
RealFlowGroupAddMember | This node adds members to the input RealFlow scene Group. |
RealFlowGroupGetMembers | This node returns members from the input RealFlow scene Group. |
RealFlowGroupRemoveMember | This node removes members from the input RealFlow scene Group. |
RealWaveIndexToPos | Returns the world coordinates of RealWave vertices given by index. |
RealWaveIndexToUV | Returns the uv's of RealWave vertices given by index. |
RealWaveMeshUpdate | Refreshes the actual states of the RealWave mesh. |
RealwaveRigging | This node allows to rig waves on the RealWave-Mesh using keyframing. |
SetArrayRealFlowNodeElement | This node returns the elements of the input 'array' at positions specified by the 'index' parameter. |
SetNodeExportResourceCheckOptionValue | This node changes the check state of an input export resource check option. |
SetNodeExportResourceValue | This node changes the information related to an export resource of the input 'node'. |
SetNodeName | This node changes the input 'node' name. |
SetNodeParameter | This node changes the value of the input 'node' parameter. |
SetRealFlowNodeGlobalVariable | This node allows the user to create a reference or a copy of the input pin in global memory to be used within other RealFlow graph through the GetGlobalVariable nodes. |
SetRealWaveMesh | This object allows changes to the RealWave mesh. |
SetRealWaveMeshFromImage | This object sets the RealWave mesh according to the input image. The scale factor defines height (y-value) and choppiness (xz-values). |
SetTransformationFromComponents | This node changes the local transformation matrix of the input 'node'. |
SetTransformationFromMatrix | This node changes the local transformation matrix of the input 'node' to the given input matrix. |
ArrayRealFlowNodeConcat
This node concatenates the inputs 'array0' and 'array1' into a single 'out' array.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array0 | RealFlow Node | The array0 | |
array1 | RealFlow Node | The array1 |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array |
ArrayRealFlowNodeConstant
This node returns a constant array.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
constant | RealFlow Node | The constant | |
size | Integer (1) | The size |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array |
ArrayRealFlowNodeFilterByMask
This node returns the elements of the input 'array' at positions specified by the 'mask' parameter.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
mask | Bit | The mask |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
result | RealFlow Node | The result |
ArrayRealFlowNodeFindAllElementIndices
This node returns all positions in the input 'array', which fit to the input 'element' values. .
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
element | RealFlow Node | The value to find in the input array |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
index | Integer | The index | |
mask | Bit | The mask |
ArrayRealFlowNodeFindElement
This node is executed in parallel according to its input pins size.
This node returns the first position of appearance of the input 'element' within the input 'array'. If the array does not contain the element, -1 is returned.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
element | RealFlow Node | The value to find in the input array | |
start index | Integer | The first index to search the element from |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
index | Integer | The index |
ArrayRealFlowNodeInsertElement
This node inserts all elements from the 'element' input into the input 'array' at the position specified by 'position'. If 'position' is equal or lower than 0 then the elements are inserted at the beginning of the array. If 'position' is greater or equal than the inputs 'array' size, elements are appended at the end.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
element | RealFlow Node | The value to insert | |
index | Integer (1) | The position to insert the input element on |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array |
ArrayRealFlowNodeMix
This node creates an output array based on the two inputs 'array0' and 'array1' and the input mask. If the mask value equals 0 then the value of 'array0' is used, if the mask value is 1 the value of 'array1' is used.
The size of the output is the same as mask's size.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array0 | RealFlow Node | The array0 | |
array1 | RealFlow Node | The array1 | |
mask | Bit | The mask |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array |
ArrayRealFlowNodePushElement
This node appends all the elements from the 'element' at the end of the input 'array'.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
element | RealFlow Node | The value to append at the end |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array |
ArrayRealFlowNodeRemoveElement
This node removes all elements of the 'by_value' from the input 'array'. The returned mask has the same size as the input 'array' and is set to 0 at removed positions.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
element | RealFlow Node | The value to remove all its instances from the input array |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array | |
mask | Bit | The mask |
ArrayRealFlowNodeRemoveIndex
This node removes all input array positions by the 'index' input. .
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
index | Integer | The positions of the input array to remove |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array |
ArrayRealFlowNodeRemoveRepeatedElements
This node removes all repetitions of elements from the input 'array'. The 'new_to_old' array can be used as an 'index' input for a GetArrayElement-Node to restore the original array. The returned mask has the same size as the input 'array' and is set to 0 at removed positions.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
new to old | Integer | The new to old | |
mask | Bit | The mask | |
out array | RealFlow Node | The out array |
ArrayRealFlowNodeResize
This node resizes the input 'array'. If the result is bigger than the input array, the last value is repeated accordingly.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
size | Integer (1) | The size |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array |
ArrayRealFlowNodeReverse
This node reverses the order of the input 'array'.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array |
ArrayRealFlowNodeSlice
This node returns an array containing the range of the input 'array' from the 'first' position with the given input 'size'.Thus, the output array is a subarray or slice of the input.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
first | Integer (1) | The position of the element that will be the first of the output array | |
size | Integer (1) | The total number of elements to copy from the input array. If value is negative, all the elements from 'first' are copied to the output array |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out array | RealFlow Node | The out array |
GetAllCameras
This node returns all the Camera nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllDaemons
This node returns all the Daemon nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllDyversoDomains
This node returns all the DyversoDomain nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllDyversoEmitters
This node returns all the DyversoEmitter nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoBubbles
This node returns all the HybridoBubble nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoDomains
This node returns all the HybridoDomain nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoEmitters
This node returns all the HybridoEmitter nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoFoams
This node returns all the HybridoFoam nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoMeshes
This node returns all the HybridoMeshe nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoMeshes_VDB
This node returns all the HybridoMeshe nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoMists
This node returns all the HybridoMist nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoSplashAndFoams
This node returns all the HybridoSplashAndFoam nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoSplashs
This node returns all the HybridoSplash nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoWaterLines
This node returns all the HybridoWaterLine nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoWetAndFoams
This node returns all the HybridoWetAndFoam nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllHybridoWets
This node returns all the HybridoWet nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllIdocs
This node returns all the Idoc nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllMultiBodies
This node returns all the MultiBodie nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllMultiJoints
This node returns all the MultiJoint nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllMultiServoPosAngulars
This node returns all the MultiServoPosAngular nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllMultiServoPosLinears
This node returns all the MultiServoPosLinear nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllMultiServoVelAngulars
This node returns all the MultiServoVelAngular nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllMultiServoVelLinears
This node returns all the MultiServoVelLinear nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllNodeExportResourceCheckOptions
This node returns all the export resource check options allowed for the input 'resource id'.
An example of export resource check option is the Alembic particle channel list: ['force','normal', ... ].
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node (1) | The node | |
resource id | Integer (1) | The id of the export resource |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
options | String | The check options allowed by the input export resource | |
value | Bit | The current check option values (checked or unchecked) |
GetAllNodeExportResourceOptions
This node returns all the export resource options allowed for the input 'resource id'.
An example of export resource option is the Alembic compression: ['No compression','0', ... ].
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node (1) | The node | |
resource id | Integer (1) | The id of the export resource |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
options | String | The options allowed by the input export resource | |
current value | String | The current option value |
GetAllNodeExportResources
This node returns all the export resource identifiers and descriptions. It is especially useful in combination with the rest of the 'Get/SetNodeExportResource' nodes.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node (1) | The node |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
resource id | Integer | The id of the export resource | |
description | String | The description of the export resource |
GetAllObjects
This node returns all the Object nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllParticleLegacyMeshes
This node returns all the ParticleLegacyMeshe nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllParticleMeshes
This node returns all the ParticleMeshe nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllParticleMeshes_VDB
This node returns all the ParticleMeshe nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllRealFlowGroups
This node returns all the RealFlowGroup nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllRealFlowNodes
This node returns all the current scene nodes.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node |
GetAllSplineNodes
This node returns all the SplineNode nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetAllStandardEmitters
This node returns all the StandardEmitter nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetArrayRealFlowNodeElement
This node returns the elements of the input 'array' at positions specified by the 'index' parameter.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
index | Integer | The index |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
element | RealFlow Node | The element |
GetCamera
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetDaemon
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetDyversoDomain
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetDyversoEmitter
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoBubbles
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoDomain
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoEmitter
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoFoam
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoMesh
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoMesh_VDB
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoMist
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoSecondaryEmitter
This node gets the RealFlow Hybrido secondary emitter.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String (1) | The name of the RealFlow node |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node |
GetHybridoSplash
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoSplashAndFoam
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoWaterLine
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoWet
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetHybridoWetAndFoam
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetIdoc
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetLinearVelocity
Returns the linear velocity of the input 'object' at the current moment.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
object | The object |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
velocity | Vector3 | The velocity |
GetMatchingCameras
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingDaemons
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingDyversoDomains
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingDyversoEmitters
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoBubbles
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoDomains
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoEmitters
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoFoams
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoMeshes
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoMeshes_VDB
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoMists
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoSplashAndFoams
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoSplashs
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoWaterLines
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoWetAndFoams
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingHybridoWets
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingIdocs
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingMultiBodies
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingMultiJoints
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingMultiServoPosAngulars
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingMultiServoPosLinears
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingMultiServoVelAngulars
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingMultiServoVelLinears
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingObjects
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingParticleLegacyMeshes
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingParticleMeshes
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingParticleMeshes_VDB
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingRealFlowGroups
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingRealFlowNodes
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node |
GetMatchingSplineNodes
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMatchingStandardEmitters
This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The wildcard pattern |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMultiBody
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMultiBodyInfo
This node returns information about the input multi-body.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
multi body node | MultiBody | The multi body node |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
no of items | Integer | The no of items | |
box | Box | The box | |
embedded | Bit | The embedded |
GetMultiBodyTransformation
This node returns an array of transformation matrices for all items within a MultiBody.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
multi body | The multi body |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
object global matrix | Matrix4 | The object global matrix | |
object local matrix | Matrix4 | The object local matrix |
GetMultiJoint
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMultiServoPosAngular
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMultiServoPosLinear
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMultiServoVelAngular
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetMultiServoVelLinear
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetNodeExportResourceCheckOptionValue
This node returns the state of the input/export resource check options.
Examples of export resource check options are e.g., the Alembic particle channel list: ['force','normal', ... ].
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | through | The node |
resource id | Integer | The id of the resource to check | |
option name | String | The name of the check option within the export resource. It is not case sensitive |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
check | Bit | True if check option is enabled | |
through | PassThrough | node | The input 'node' |
GetNodeExportResourceIdFromDescription
This node returns all the information related to an export resource of the input 'node'. If the resource does not exist and the 'exists' output is not connected, an error message is displayed.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node | |
description | String | The description of the export resource to get the id from. It is not case-sensitive |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
resource id | Integer | The id of the export resource from the input 'node' that matches the input 'description'. -1 otherwise | |
exists | Bit | True if the resource exists for the input node. False otherwise. An error message will be displayed if this output is not connected and the resource does not exist for the input node |
GetNodeExportResourceInfo
This node returns all the information related to an export resource of the input 'node'. If the resource does not exist and the 'exists' output is not connected, an error message is displayed.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node | |
resource id | Integer | The id of the resource to check |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
exists | Bit | True if the resource exists for the input node. False otherwise. An error message will be displayed if this output is not connected and the resource does not exist for the input node | |
active | Bit | True if the resource export is enabled | |
name | String | The name of the exported resource. Typically, it is the same for all resources in a node | |
path | String | The path of the exported resource | |
description | String | The description of the exported resource | |
extension | String | The file extension used by the exported resource | |
has options | Bit | True if the exported resource has extra options. An example of resource options is the Compression of an Alembic export resource | |
option | String | The option selected for the exported resource. An empty string if the exported resource does not accept options | |
has check options | Bit | True if the exported resource accepts additional check options. For example, the channels in an Alembic export resource |
GetNodeName
This node returns the input 'node' name.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
GetNodeParameter
This node returns the value of the input 'node' parameter.
Only the compatible output values are actually modified.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node | |
parameter | String (1) | The parameter |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
string | String | The string value of the parameter in case the parameter is of the string type | |
number | The number value of the parameter in case the parameter is of number type | ||
bit | Bit | The bit | |
node value | RealFlow Node | The boolean value of the parameter in case the parameter is of boolean type | |
type | ParameterType | The parameter type for info purposes |
GetNodeParameterType
This node returns the value of the input 'node' parameter.
Only the compatible output values are actually modified.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node | |
parameter | String | The parameter |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
type | ParameterType | The parameter type |
GetObject
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetParticleLegacyMesh
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetParticleMesh
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetParticleMesh_VDB
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetRealFlowGroup
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetRealFlowNode
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node |
GetRealFlowNodeGlobalVariable
This node returns a reference to previously stored variables in global memory (using the SetGlobalVariable-Nodes).
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String (1) | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out | RealFlow Node | The out |
GetRealWaveAsHeightfieldImage
This node is executed in parallel according to its input pins size.
Returns a greyscale, 32bit image, containing the realwave surface as a heightfield. The search radius defines the area to be searched for neighboring polygons. For non-choppy surfaces, the radius may be low. For choppy-surfaces use high values (around 1.0), but take note, those values may result in poor performance, since choppy surfaces are converted to plain heightfields. The epsilon value describes an offset, which is reducing artifacts on the border. If polygons on the border are set to minimal height, increase this value.
With the color scale, the encoding of heights into colors can be scaled. Decrease this value, if the heights are cropped.
Finally, the switch 'tiles' defines, if the resulting surface should be tilable. If set to 'no' the resulting image represents the exact borders of the quadratic initialized grid. If choppy waves are used, the corner are clamped, resulting in a black color within these areas.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
mesh | RealWaveMesh (1) | The mesh | |
search radius | Real (1) | The search radius | |
border epsilon | Real (1) | The border epsilon | |
image resolution | Integer (1) | The image resolution | |
color scale | Real (1) | The color scale | |
tiled | Bit (1) | The tiled |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out image | Image | The out image |
GetRealWaveHeightAt
This node is executed in parallel according to its input pins size.
Determines the height of a RealWave surface at the given input point (x,y,z) - the y coordinate is not considered and thus, may be 0. Returns the corresponding point on the surface (x,h,z). If the surface is not existing at the spppecified points position, the original, unchanged point (x,y,z) is returned.
The parameter search radius defines the area, in which possible heights are searched. It strongly depends onchoppyness. If no choppyness is used, a low value may be used. Take note, the performance increases quadratically with the search radius.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
vector | Vector3 | The vector | |
mesh | RealWaveMesh | The mesh | |
search radius | Real | The search radius |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out vector | Vector3 | The out vector |
GetRealWaveInfo
This node returns information about the RealWave.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
mesh | RealWaveMesh (1) | The mesh |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
no of vertices | Integer | The no of vertices | |
no of triangles | Integer | The no of triangles | |
bounding box | Box | The bounding box | |
initial dimension | Box | The initial dimension |
GetRealWaveMesh
This object returns a reference to the RealWave mesh.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
mesh | RealWaveMesh | The mesh |
GetSelectedNodes
This node returns the selected nodes in the scene.
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
nodes | RealFlow Node | The nodes |
GetSplineNode
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetStandardEmitter
This node returns the scene node that matches exactly the input 'name'.
It is case sensitive.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | The node |
GetTransformation
This node returns all transformations of the input 'node'.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
matrix | Matrix4 | The matrix | |
position | Vector3 | The position | |
rotation | Vector3 | The rotation | |
scale | Vector3 | The scale | |
shear | Vector3 | The shear | |
pivot | Vector3 | The pivot |
NodeEnableExportData
This node changes the input 'node' active state for exporting data.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | out node | The node |
enable | Bit | True to allow data export from the input node |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out node | PassThrough | node | The out node |
NodeExportDataIsActive
This node returns the input 'node' active state for exporting data.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | through | The node |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
active | Bit | True if the node is allowed to export data | |
through | PassThrough | node | The input 'node' |
RealFlowGroupAddMember
This node adds members to the input RealFlow scene Group.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
group | out group | Group to add the node to | |
node | RealFlow Node | Node or group to add to the input group |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out group | PassThrough | group | The out group |
RealFlowGroupGetMembers
This node returns members from the input RealFlow scene Group.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
group | through | Group to get the nodes from | |
recursive | Bit (1) | True to expand groups that belong to the input group |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
nodes | RealFlow Node | Nodes that belong to the group | |
through | PassThrough | group | The input 'group' |
RealFlowGroupRemoveMember
This node removes members from the input RealFlow scene Group.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
group | out group | Group to remove the node from | |
node | RealFlow Node | Node or group to remove from the input group |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out group | PassThrough | group | The out group |
RealWaveIndexToPos
Returns the world coordinates of RealWave vertices given by index.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
index | Integer | The index | |
mesh | RealWaveMesh | The mesh |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
vector | Vector3 | The vector |
RealWaveIndexToUV
Returns the uv's of RealWave vertices given by index.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
index | Integer | The index | |
mesh | RealWaveMesh | The mesh |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
vector | Vector3 | The vector |
RealWaveMeshUpdate
Refreshes the actual states of the RealWave mesh.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
mesh | RealWaveMesh | out mesh | The mesh |
face normals | Bit (1) | The face normals | |
vertex up | Bit (1) | The vertex up | |
vertex normals | Bit (1) | The vertex normals | |
bounding box | Bit (1) | The bounding box | |
depth map | Bit (1) | The depth map |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out mesh | RealWaveMesh | mesh | The out mesh |
RealwaveRigging
This node allows to rig waves on the RealWave-Mesh using keyframing.
The node is split into 4 groups of parameters:
1. The first group of parameters are controlling the deformation, the rigging-style and intensities. You may consider the position as a cylinder positioned in space, whereas the deformation only affects the surface within the radius of the cylinders radius.
2. The second group defines the falldown style at the sides of the wave.
3. Additional to standard waves, this node is able to rig radial waves (which may be used to imitate waves, caused by falling objects) - the radial waves can be controlled with third set of parameters.
4. Finally, this node allows the creation of splash particles at the waves peak. The behavior of these particles is defined by the last set of parameters.
In the following, a brief explanation of each concrete parameter will be given (see below). Additionally, we recommend to check out the examples, provided with this real flow distribution, since there are further informations given.
Finally, we would like to point out some additional facts about this node:
- This node allows the rigging of waves. Use a cylinder within the scene, rotate it by 90 degree and connect it to the position slot and the cylinders x-scale to the radius slot. Thus, you will have a good position and size control over the rigged wave.
- The animation style of the wave totally depends on controlling the transformation of the cylinder. Use keyframing, to tweak the behavior of the wave appropriate.
- The y-position of the cylinder is one of the main parameters, to control the visual style of the wave. Typically, the y-position should be above the surface - thus, the wave is rigged into the up direction, which is usually desired. The closer the cylinder is to the surface, the stringer the deformation is. Additionally, use the 'intensity' and 'intensity smooth' parameters to tweak the wave.
- This node is well suited for rolling and rising waves. It does not work very well, if the wave finally totally breaks. In those cases, you may achieve some 'comic style' results, which may lack of realism.
- Particles are only determined and emitted, if one of the out pins 'emitter pos' or 'emitter vel' is connected.
.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
mesh in | RealWaveMesh | RealWave Mesh | |
position | Vector3 (1) | The center of influence. You may consider this position as the center of a cylinder, whereas the dimensions of the cylinder defines the area of influence to the mesh. Take note, that the height (y-coordinate) is influencing the intensity of rigging and thus, wave-style, immensely | |
rotation | Real (1) | The orientation of influence. Using this paramater, you may rotate the waves orientation around the y-axis | |
width | Real (1) | The width of the wave. If connected to a cylinder, this represents the height of the cylinder - within this area, the full deformation is applied, whereas in the falldown areas the intensity is reduced constantly | |
radius | Real (1) | The radius of influence. Within this axis-radius, the rigging is fullfilled | |
intensity | Real (1) | The intensity of rigging. Higher values mean higher intensities | |
intensity smooth | Integer (1) | This parameter reduces the spirality of the rigging. Increasing the value results in slower ascending and descending waves. Using this parameter, the appearance of the wave can be tweaked strongly. Typical values are between 1 and 4 | |
l falldown func | Defines the falldown function. Normally, the parameter 'curve' should be used. The parameter is only used for linear waves (particularly, not for radial waves) | ||
l falldown width | Real (1) | Defines the width of the left falldown area of the wave. The intensity is decreased to 0 at distance width. The parameter is only used for linear waves (particularly, not for radial waves) | |
r falldown func | Similar to 'l falldown func' | ||
r falldown width | Real (1) | Similar to 'l falldown width' | |
anti spiral enable | Bit (1) | The basic principle of the wave deformation provided by this node is a spiral deformation. Normally, a spiral is not what you would like to produce. For strong deformations, you may unroll the spiral, starting from a freely chosen angel. From that area on, the spiral is unrolled to a linear function, allowing the wave to intersect the water surface. This parameter enables the anti-spiral functionality | |
anti spiral angle | Real (1) | This angle defines the angle, from which on the spiral is unrolled. The angle start backwards from a 360 degree deformation. Thus, 90 degrees imply a vertical down direction and 180 degrees imply a horizontal direction into the direction of rolling. Any value in between may be chosen | |
anti spiral curve | Real (1) | Since a plain linear function does not always represent a meaningfull wave, you may use this parameter to map the unrolled linear function back to a slight curve. Thus, different breaking styles may be represented | |
radial enable | Bit (1) | This parameter enables radial waves. Radial waves are located around the center, which is specified in the following parameter. The radius of the radial wave is determined according to the position vector (see above) and the center position | |
radial center | Vector3 (1) | The center of the radial wave | |
radial fade angle | Real (1) | This parameter defines the direction of asymmetry. Using asymmetry the radial wave's deformation intensity is varied according to direction. Thus, the wave representation of objects falling into water with a horizontal velocity is possible | |
radial fade start | Real (1) | This parameter defines the intensity of the lowest point of radial asymmetry. In particular, the start deformation intensity on the opposite side of the in the previous parameter specified direction. The value ranges between 0 (=total assymetriy) and 1 (=symmetry) | |
emit angle thresh | Real (1) | Starting from this threshold on, new particles are created if the deformed surface exceeds this angle. The angle is defined similar to the angle 'anti spiral angle' - e.g., 90 degrees imply a vertical down direction and 180 degrees imply a horizontal direction into the direction of rolling. Any value in between may be chosen | |
emit pos offs | Real (1) | A y-threshold which is added to the emitter position. Might be helpful in some circumstances | |
emit vel | Real (1) | Defines the emitters absolute velocity. Should depend on the speed of the wave | |
emit vel angle | Real (1) | Defines the emitters velocity direction. As a starting point, the same angle like 'emit angle thresh' can be used. The angle is defined similar to the angle 'anti spiral angle' - e.g., 90 degrees imply a vertical down direction and 180 degrees imply a horizontal direction into the direction of rolling | |
emit jitter | Real (1) | Add jittering to the particle creation positions, to reduce visible patterns within the created particles. |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
mesh out | RealWaveMesh | The new real wave mesh, including the deformation | |
emitter pos | Vector3 | The position of newly created particles at the wave peak. To use them within your scene, you may use the 'addParticle'-Node | |
emitter vel | Vector3 | The velocity of newly created particles at the wave peak |
SetArrayRealFlowNodeElement
This node returns the elements of the input 'array' at positions specified by the 'index' parameter.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
array | RealFlow Node | The array | |
index | Integer | The index | |
element | RealFlow Node | The element |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
result | RealFlow Node | The result |
SetNodeExportResourceCheckOptionValue
This node changes the check state of an input export resource check option.
An example of export resource check option is the Alembic particle channel list: ['force','normal', ... ].
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | out node | The node |
resource id | Integer | The id of the resource to check | |
option name | String | The name of the check option of the export resource. It is not case sensitive | |
check | Bit | True to enable the check option |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out node | PassThrough | node | The out node |
SetNodeExportResourceValue
This node changes the information related to an export resource of the input 'node'.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | out node | The node |
resource id | Integer | The id of the resource to check | |
enable | Bit | True to enable the export resource | |
name | String | The name of the exported resource | |
path | String | The path of the exported resource | |
option | String | The option to set for the exported resource. It is not case-sensitive |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out node | PassThrough | node | The out node |
SetNodeName
This node changes the input 'node' name.
Currently only the internal name is changed, and change is not reflected in the user interface.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node | |
name | String | The name |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
evaluate | Evaluate | The evaluate |
SetNodeParameter
This node changes the value of the input 'node' parameter.
Only the compatible input values are actually taken into account.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | out node | The node |
parameter | String (1) | The parameter | |
string value | String | The string value for the parameter in case the parameter is of the string type | |
number value | The number value for the parameter in case the parameter is of number type | ||
bit value | Bit | The bit value | |
node value | RealFlow Node | The node value for the parameter in case the parameter is of node type |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out node | PassThrough | node | The out node |
SetRealFlowNodeGlobalVariable
This node allows the user to create a reference or a copy of the input pin in global memory to be used within other RealFlow graph through the GetGlobalVariable nodes.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
name | String (1) | The name | |
in | RealFlow Node | through | The in |
store copy | Bit (1) | The store copy |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
through | PassThrough | in | The value connected to the input |
out copy | RealFlow Node | The value copied in memory in case a copy has been performed. The same input value otherwise |
SetRealWaveMesh
This object allows changes to the RealWave mesh.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
positions | Vector3 | The new position of the vertex in world space | |
ids | Integer | The ids |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
evaluate | Evaluate | The evaluate |
SetRealWaveMeshFromImage
This object sets the RealWave mesh according to the input image. The scale factor defines height (y-value) and choppiness (xz-values).
The input image can be projected tiled and non-tiled. Projecting tiled allows the creation of tiled grids, whereas non-tiledis an accurate projection of the image on to the grid.
To get exactly the same results for the 'ImageOceanStatisticalSpectrum'-Node like the standard RealWave Statistical Spectrum, set the 'tiled'-option to 'yes', since the RealWave is always tilable.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
image | Image (1) | The image. Its bit depth must be 32 bit | |
mesh | RealWaveMesh (1) | out mesh | The mesh |
scale xyz | Vector3 (1) | The scale xyz | |
tiled | Bit (1) | The tiled |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
out mesh | RealWaveMesh | mesh | The out mesh |
SetTransformationFromComponents
This node changes the local transformation matrix of the input 'node'.
The transformation is defined by the translation, rotation and scale vectors.
.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node | |
translation | Vector3 | The translation | |
rotation | Vector3 | The rotation | |
scale | Vector3 | The scale |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
evaluate | Evaluate | The evaluate |
SetTransformationFromMatrix
This node changes the local transformation matrix of the input 'node' to the given input matrix.
.
Inputs
Name | Types | PassThrough | Description |
---|---|---|---|
node | RealFlow Node | The node | |
matrix | Matrix4 | The matrix |
Outputs
Name | Types | PassThrough | Description |
---|---|---|---|
evaluate | Evaluate | The evaluate |