Scene Node

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

NameDescription
ArrayRealFlowNodeConcatThis node concatenates the inputs 'array0' and 'array1' into a single 'out' array.
ArrayRealFlowNodeConstantThis node returns a constant array.
ArrayRealFlowNodeFilterByMaskThis node returns the elements of the input 'array' at positions specified by the 'mask' parameter.
ArrayRealFlowNodeFindAllElementIndicesThis node returns all positions in the input 'array', which fit to the input 'element' values.
ArrayRealFlowNodeFindElementThis 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.
ArrayRealFlowNodeInsertElementThis 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.
ArrayRealFlowNodeMixThis 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.
ArrayRealFlowNodePushElementThis node appends all the elements from the 'element' at the end of the input 'array'.
ArrayRealFlowNodeRemoveElementThis 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.
ArrayRealFlowNodeRemoveIndexThis node removes all input array positions by the 'index' input.
ArrayRealFlowNodeRemoveRepeatedElementsThis 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.
ArrayRealFlowNodeResizeThis node resizes the input 'array'. If the result is bigger than the input array, the last value is repeated accordingly.
ArrayRealFlowNodeReverseThis node reverses the order of the input 'array'.
ArrayRealFlowNodeSliceThis 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.
GetAllCamerasThis node returns all the Camera nodes in the scene.
GetAllDaemonsThis node returns all the Daemon nodes in the scene.
GetAllDyversoDomainsThis node returns all the DyversoDomain nodes in the scene.
GetAllDyversoEmittersThis node returns all the DyversoEmitter nodes in the scene.
GetAllHybridoBubblesThis node returns all the HybridoBubble nodes in the scene.
GetAllHybridoDomainsThis node returns all the HybridoDomain nodes in the scene.
GetAllHybridoEmittersThis node returns all the HybridoEmitter nodes in the scene.
GetAllHybridoFoamsThis node returns all the HybridoFoam nodes in the scene.
GetAllHybridoMeshesThis node returns all the HybridoMeshe nodes in the scene.
GetAllHybridoMeshes_VDBThis node returns all the HybridoMeshes_VD nodes in the scene.
GetAllHybridoMistsThis node returns all the HybridoMist nodes in the scene.
GetAllHybridoSplashAndFoamsThis node returns all the HybridoSplashAndFoam nodes in the scene.
GetAllHybridoSplashsThis node returns all the HybridoSplash nodes in the scene.
GetAllHybridoWaterLinesThis node returns all the HybridoWaterLine nodes in the scene.
GetAllHybridoWetAndFoamsThis node returns all the HybridoWetAndFoam nodes in the scene.
GetAllHybridoWetsThis node returns all the HybridoWet nodes in the scene.
GetAllIdocsThis node returns all the Idoc nodes in the scene.
GetAllMultiBodiesThis node returns all the MultiBodie nodes in the scene.
GetAllMultiJointsThis node returns all the MultiJoint nodes in the scene.
GetAllMultiServoPosAngularsThis node returns all the MultiServoPosAngular nodes in the scene.
GetAllMultiServoPosLinearsThis node returns all the MultiServoPosLinear nodes in the scene.
GetAllMultiServoVelAngularsThis node returns all the MultiServoVelAngular nodes in the scene.
GetAllMultiServoVelLinearsThis node returns all the MultiServoVelLinear nodes in the scene.
GetAllNodeExportResourceCheckOptionsThis node returns all the export resource check options allowed for the input 'resource id'.
GetAllNodeExportResourceOptionsThis node returns all the export resource options allowed for the input 'resource id'.
GetAllNodeExportResourcesThis node returns all the export resource identifiers and descriptions. It is especially useful in combination with the rest of the 'Get/SetNodeExportResource' nodes.
GetAllObjectsThis node returns all the Object nodes in the scene.
GetAllParticleLegacyMeshesThis node returns all the ParticleLegacyMeshe nodes in the scene.
GetAllParticleMeshesThis node returns all the ParticleMeshe nodes in the scene.
GetAllParticleMeshes_VDBThis node returns all the ParticleMeshes_VD nodes in the scene.
GetAllRealFlowGroupsThis node returns all the RealFlowGroup nodes in the scene.
GetAllRealFlowNodesThis node returns all the current scene nodes.
GetAllSplineNodesThis node returns all the SplineNode nodes in the scene.
GetAllStandardEmittersThis node returns all the StandardEmitter nodes in the scene.
GetArrayRealFlowNodeElementThis node returns the elements of the input 'array' at positions specified by the 'index' parameter.
GetCameraThis node returns the scene node that matches exactly the input 'name'.
GetDaemonThis node returns the scene node that matches exactly the input 'name'.
GetDyversoDomainThis node returns the scene node that matches exactly the input 'name'.
GetDyversoEmitterThis node returns the scene node that matches exactly the input 'name'.
GetHybridoBubblesThis node returns the scene node that matches exactly the input 'name'.
GetHybridoDomainThis node returns the scene node that matches exactly the input 'name'.
GetHybridoEmitterThis node returns the scene node that matches exactly the input 'name'.
GetHybridoFoamThis node returns the scene node that matches exactly the input 'name'.
GetHybridoMeshThis node returns the scene node that matches exactly the input 'name'.
GetHybridoMesh_VDBThis node returns the scene node that matches exactly the input 'name'.
GetHybridoMistThis node returns the scene node that matches exactly the input 'name'.
GetHybridoSecondaryEmitterThis node gets the RealFlow Hybrido secondary emitter.
GetHybridoSplashThis node returns the scene node that matches exactly the input 'name'.
GetHybridoSplashAndFoamThis node returns the scene node that matches exactly the input 'name'.
GetHybridoWaterLineThis node returns the scene node that matches exactly the input 'name'.
GetHybridoWetThis node returns the scene node that matches exactly the input 'name'.
GetHybridoWetAndFoamThis node returns the scene node that matches exactly the input 'name'.
GetIdocThis node returns the scene node that matches exactly the input 'name'.
GetLinearVelocityReturns the linear velocity of the input 'object' at the current moment.
GetMatchingCamerasThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingDaemonsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingDyversoDomainsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingDyversoEmittersThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoBubblesThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoDomainsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoEmittersThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoFoamsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoMeshesThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoMeshes_VDBThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoMistsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoSplashAndFoamsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoSplashsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoWaterLinesThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoWetAndFoamsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingHybridoWetsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingIdocsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingMultiBodiesThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingMultiJointsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingMultiServoPosAngularsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingMultiServoPosLinearsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingMultiServoVelAngularsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingMultiServoVelLinearsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingObjectsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingParticleLegacyMeshesThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingParticleMeshesThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingParticleMeshes_VDBThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingRealFlowGroupsThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingRealFlowNodesThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingSplineNodesThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMatchingStandardEmittersThis node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.
GetMultiBodyThis node returns the scene node that matches exactly the input 'name'.
GetMultiBodyInfoThis node returns information about the input multi-body.
GetMultiBodyTransformationThis node returns an array of transformation matrices for all items within a MultiBody.
GetMultiJointThis node returns the scene node that matches exactly the input 'name'.
GetMultiServoPosAngularThis node returns the scene node that matches exactly the input 'name'.
GetMultiServoPosLinearThis node returns the scene node that matches exactly the input 'name'.
GetMultiServoVelAngularThis node returns the scene node that matches exactly the input 'name'.
GetMultiServoVelLinearThis node returns the scene node that matches exactly the input 'name'.
GetNodeExportResourceCheckOptionValueThis node returns the state of the input/export resource check options.
GetNodeExportResourceIdFromDescriptionThis 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.
GetNodeExportResourceInfoThis 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.
GetNodeNameThis node returns the input 'node' name.
GetNodeParameterThis node returns the value of the input 'node' parameter.
GetNodeParameterTypeThis node returns the value of the input 'node' parameter.
GetObjectThis node returns the scene node that matches exactly the input 'name'.
GetParticleLegacyMeshThis node returns the scene node that matches exactly the input 'name'.
GetParticleMeshThis node returns the scene node that matches exactly the input 'name'.
GetParticleMesh_VDBThis node returns the scene node that matches exactly the input 'name'.
GetRealFlowGroupThis node returns the scene node that matches exactly the input 'name'.
GetRealFlowNodeThis node returns the scene node that matches exactly the input 'name'.
GetRealFlowNodeGlobalVariableThis node returns a reference to previously stored variables in global memory (using the SetGlobalVariable-Nodes).
GetRealWaveAsHeightfieldImageReturns 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.
GetRealWaveHeightAtDetermines 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.
GetRealWaveInfoThis node returns information about the RealWave.
GetRealWaveMeshThis object returns a reference to the RealWave mesh.
GetSelectedNodesThis node returns the selected nodes in the scene.
GetSplineNodeThis node returns the scene node that matches exactly the input 'name'.
GetStandardEmitterThis node returns the scene node that matches exactly the input 'name'.
GetTransformationThis node returns all transformations of the input 'node'.
NodeEnableExportDataThis node changes the input 'node' active state for exporting data.
NodeExportDataIsActiveThis node returns the input 'node' active state for exporting data.
RealFlowGroupAddMemberThis node adds members to the input RealFlow scene Group.
RealFlowGroupGetMembersThis node returns members from the input RealFlow scene Group.
RealFlowGroupRemoveMemberThis node removes members from the input RealFlow scene Group.
RealWaveIndexToPosReturns the world coordinates of RealWave vertices given by index.
RealWaveIndexToUVReturns the uv's of RealWave vertices given by index.
RealWaveMeshUpdateRefreshes the actual states of the RealWave mesh.
RealwaveRiggingThis node allows to rig waves on the RealWave-Mesh using keyframing.
SetArrayRealFlowNodeElementThis node returns the elements of the input 'array' at positions specified by the 'index' parameter.
SetMultiBodyTransformationThis node changes the global transformation matrix of the bodies of the input MultiBody 'node' to the given input matrix.
SetNodeExportResourceCheckOptionValueThis node changes the check state of an input export resource check option.
SetNodeExportResourceValueThis node changes the information related to an export resource of the input 'node'.
SetNodeNameThis node changes the input 'node' name.
SetNodeParameterThis node changes the value of the input 'node' parameter.
SetRealFlowNodeGlobalVariableThis 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.
SetRealWaveMeshThis object allows changes to the RealWave mesh.
SetRealWaveMeshFromImageThis object sets the RealWave mesh according to the input image. The scale factor defines height (y-value) and choppiness (xz-values).
SetTransformationFromComponentsThis node changes the local transformation matrix of the input 'node'.
SetTransformationFromMatrixThis 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

NameTypesPassThroughDescription
array0RealFlow Node
 Optional

out array

The array0

array1RealFlow Node
 Optional

out array

The array1

Outputs

NameTypesPassThroughDescription
out arrayRealFlow Node
 Optional

array0
array1

The out array

 

ArrayRealFlowNodeConstant

This node returns a constant array.

Inputs

NameTypesPassThroughDescription
constantRealFlow Node 

The constant

sizeInteger (1) 

The size

Outputs

NameTypesPassThroughDescription
out arrayRealFlow Node 

The out array

 

ArrayRealFlowNodeFilterByMask

This node returns the elements of the input 'array' at positions specified by the 'mask' parameter.

Inputs

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

result

The array

maskBit 

The mask

Outputs

NameTypesPassThroughDescription
resultRealFlow Node
 Optional

array

The result

 

ArrayRealFlowNodeFindAllElementIndices

This node returns all positions in the input 'array', which fit to the input 'element' values. .

Inputs

NameTypesPassThroughDescription
arrayRealFlow Node 

The array

elementRealFlow Node 

The value to find in the input array

Outputs

NameTypesPassThroughDescription
indexInteger 

The index

maskBit 

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

NameTypesPassThroughDescription
arrayRealFlow Node 

The array

elementRealFlow Node 

The value to find in the input array

start indexInteger 

The first index to search the element from

Outputs

NameTypesPassThroughDescription
indexInteger 

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

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

out array

The array

elementRealFlow Node 

The value to insert

indexInteger (1) 

The position to insert the input element on

Outputs

NameTypesPassThroughDescription
out arrayRealFlow Node
 Optional

array

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

NameTypesPassThroughDescription
array0RealFlow Node
 Optional

out array

The array0

array1RealFlow Node
 Optional

out array

The array1

maskBit 

The mask

Outputs

NameTypesPassThroughDescription
out arrayRealFlow Node
 Optional

array0
array1

The out array

 

ArrayRealFlowNodePushElement

This node appends all the elements from the 'element' at the end of the input 'array'.

Inputs

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

out array

The array

elementRealFlow Node 

The value to append at the end

Outputs

NameTypesPassThroughDescription
out arrayRealFlow Node
 Optional

array

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

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

out array

The array

elementRealFlow Node 

The value to remove all its instances from the input array

Outputs

NameTypesPassThroughDescription
out arrayRealFlow Node
 Optional

array

The out array

maskBit 

The mask

 

ArrayRealFlowNodeRemoveIndex

This node removes all input array positions by the 'index' input. .

Inputs

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

out array

The array

indexInteger 

The positions of the input array to remove

Outputs

NameTypesPassThroughDescription
out arrayRealFlow Node
 Optional

array

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

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

out array

The array

Outputs

NameTypesPassThroughDescription
new to oldInteger 

The new to old

maskBit 

The mask

out arrayRealFlow Node
 Optional

array

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

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

out array

The array

sizeInteger (1) 

The size

Outputs

NameTypesPassThroughDescription
out arrayRealFlow Node
 Optional

array

The out array

 

ArrayRealFlowNodeReverse

This node reverses the order of the input 'array'.

Inputs

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

out array

The array

Outputs

NameTypesPassThroughDescription
out arrayRealFlow Node
 Optional

array

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

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

out array

The array

firstInteger (1) 

The position of the element that will be the first of the output array

sizeInteger (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

NameTypesPassThroughDescription
out arrayRealFlow Node
 Optional

array

The out array

 

GetAllCameras

This node returns all the Camera nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 Camera

Camera
RealFlowNode

 

The node

 

GetAllDaemons

This node returns all the Daemon nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 Daemon

Daemon
RealFlowNode

 

The node

 

GetAllDyversoDomains

This node returns all the DyversoDomain nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 DyversoDomain

DyversoDomain
RealFlowNode

 

The node

 

GetAllDyversoEmitters

This node returns all the DyversoEmitter nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 DyversoEmitter

DyversoEmitter
RealFlowNode

 

The node

 

GetAllHybridoBubbles

This node returns all the HybridoBubble nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoBubbles

HybridoBubbles
RealFlowNode

 

The node

 

GetAllHybridoDomains

This node returns all the HybridoDomain nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoDomain

HybridoDomain
RealFlowNode

 

The node

 

GetAllHybridoEmitters

This node returns all the HybridoEmitter nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoEmitter

HybridoEmitter
RealFlowNode

 

The node

 

GetAllHybridoFoams

This node returns all the HybridoFoam nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoFoam

HybridoFoam
RealFlowNode

 

The node

 

GetAllHybridoMeshes

This node returns all the HybridoMeshe nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoMesh

HybridoMesh
RealFlowNode

 

The node

 

GetAllHybridoMeshes_VDB

This node returns all the HybridoMeshes_VD nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoMesh_VDB

HybridoMesh_VDB
RealFlowNode

 

The node

 

GetAllHybridoMists

This node returns all the HybridoMist nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoMist

HybridoMist
RealFlowNode

 

The node

 

GetAllHybridoSplashAndFoams

This node returns all the HybridoSplashAndFoam nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoSplashAndFoam

HybridoSplashAndFoam
RealFlowNode

 

The node

 

GetAllHybridoSplashs

This node returns all the HybridoSplash nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoSplash

HybridoSplash
RealFlowNode

 

The node

 

GetAllHybridoWaterLines

This node returns all the HybridoWaterLine nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoWaterLine

HybridoWaterLine
RealFlowNode

 

The node

 

GetAllHybridoWetAndFoams

This node returns all the HybridoWetAndFoam nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoWetAndFoam

HybridoWetAndFoam
RealFlowNode

 

The node

 

GetAllHybridoWets

This node returns all the HybridoWet nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 HybridoWet

HybridoWet
RealFlowNode

 

The node

 

GetAllIdocs

This node returns all the Idoc nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 Idoc

IDOC
RealFlowNode

 

The node

 

GetAllMultiBodies

This node returns all the MultiBodie nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 MultiBody

MultiBody
RealFlowNode

 

The node

 

GetAllMultiJoints

This node returns all the MultiJoint nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 MultiJoint

MultiJoint
RealFlowNode

 

The node

 

GetAllMultiServoPosAngulars

This node returns all the MultiServoPosAngular nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 MultiServoPosAngular

MultiServoPosAngular
RealFlowNode

 

The node

 

GetAllMultiServoPosLinears

This node returns all the MultiServoPosLinear nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 MultiServoPosLinear

MultiServoPosLinear
RealFlowNode

 

The node

 

GetAllMultiServoVelAngulars

This node returns all the MultiServoVelAngular nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 MultiServoVelAngular

MultiServoVelAngular
RealFlowNode

 

The node

 

GetAllMultiServoVelLinears

This node returns all the MultiServoVelLinear nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 MultiServoVelLinear

MultiServoVelLinear
RealFlowNode

 

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

NameTypesPassThroughDescription
nodeRealFlow Node (1) 

The node

resource idInteger (1) 

The id of the export resource

Outputs

NameTypesPassThroughDescription
optionsString 

The check options allowed by the input export resource

valueBit 

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

NameTypesPassThroughDescription
nodeRealFlow Node (1) 

The node

resource idInteger (1) 

The id of the export resource

Outputs

NameTypesPassThroughDescription
optionsString 

The options allowed by the input export resource

current valueString 

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

NameTypesPassThroughDescription
nodeRealFlow Node (1) 

The node

Outputs

NameTypesPassThroughDescription
resource idInteger 

The id of the export resource

descriptionString 

The description of the export resource

 

GetAllObjects

This node returns all the Object nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 Object

Object
RealFlowNode

 

The node

 

GetAllParticleLegacyMeshes

This node returns all the ParticleLegacyMeshe nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 ParticleLegacyMesh

ParticleLegacyMesh
RealFlowNode

 

The node

 

GetAllParticleMeshes

This node returns all the ParticleMeshe nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 ParticleMesh

ParticleMesh
RealFlowNode

 

The node

 

GetAllParticleMeshes_VDB

This node returns all the ParticleMeshes_VD nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 ParticleMesh_VDB

ParticleMesh_VDB
RealFlowNode

 

The node

 

GetAllRealFlowGroups

This node returns all the RealFlowGroup nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 RealFlowGroup

RealFlowGroup
RealFlowNode

 

The node

 

GetAllRealFlowNodes

This node returns all the current scene nodes.

Outputs

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

 

GetAllSplineNodes

This node returns all the SplineNode nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 SplineNode

SplineNode
RealFlowNode

 

The node

 

GetAllStandardEmitters

This node returns all the StandardEmitter nodes in the scene.

Outputs

NameTypesPassThroughDescription
node
 StandardEmitter

StandardEmitter
RealFlowNode

 

The node

 

GetArrayRealFlowNodeElement

This node returns the elements of the input 'array' at positions specified by the 'index' parameter.

Inputs

NameTypesPassThroughDescription
arrayRealFlow Node 

The array

indexInteger 

The index

Outputs

NameTypesPassThroughDescription
elementRealFlow Node 

The element

 

GetCamera

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 Camera

Camera
RealFlowNode

 

The node

 

GetDaemon

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 Daemon

Daemon
RealFlowNode

 

The node

 

GetDyversoDomain

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 DyversoDomain

DyversoDomain
RealFlowNode

 

The node

 

GetDyversoEmitter

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 DyversoEmitter

DyversoEmitter
RealFlowNode

 

The node

 

GetHybridoBubbles

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoBubbles

HybridoBubbles
RealFlowNode

 

The node

 

GetHybridoDomain

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoDomain

HybridoDomain
RealFlowNode

 

The node

 

GetHybridoEmitter

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoEmitter

HybridoEmitter
RealFlowNode

 

The node

 

GetHybridoFoam

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoFoam

HybridoFoam
RealFlowNode

 

The node

 

GetHybridoMesh

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoMesh

HybridoMesh
RealFlowNode

 

The node

 

GetHybridoMesh_VDB

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoMesh_VDB

HybridoMesh_VDB
RealFlowNode

 

The node

 

GetHybridoMist

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoMist

HybridoMist
RealFlowNode

 

The node

 

GetHybridoSecondaryEmitter

This node gets the RealFlow Hybrido secondary emitter.

Inputs

NameTypesPassThroughDescription
nameString (1) 

The name of the RealFlow node

Outputs

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

 

GetHybridoSplash

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoSplash

HybridoSplash
RealFlowNode

 

The node

 

GetHybridoSplashAndFoam

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoSplashAndFoam

HybridoSplashAndFoam
RealFlowNode

 

The node

 

GetHybridoWaterLine

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoWaterLine

HybridoWaterLine
RealFlowNode

 

The node

 

GetHybridoWet

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoWet

HybridoWet
RealFlowNode

 

The node

 

GetHybridoWetAndFoam

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 HybridoWetAndFoam

HybridoWetAndFoam
RealFlowNode

 

The node

 

GetIdoc

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 Idoc

IDOC
RealFlowNode

 

The node

 

GetLinearVelocity

Returns the linear velocity of the input 'object' at the current moment.

Inputs

NameTypesPassThroughDescription
object
 Object

Object
RealFlowNode

 

The object

Outputs

NameTypesPassThroughDescription
velocityVector3 

The velocity

 

GetMatchingCameras

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 Camera

Camera
RealFlowNode

 

The node

 

GetMatchingDaemons

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 Daemon

Daemon
RealFlowNode

 

The node

 

GetMatchingDyversoDomains

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 DyversoDomain

DyversoDomain
RealFlowNode

 

The node

 

GetMatchingDyversoEmitters

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 DyversoEmitter

DyversoEmitter
RealFlowNode

 

The node

 

GetMatchingHybridoBubbles

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoBubbles

HybridoBubbles
RealFlowNode

 

The node

 

GetMatchingHybridoDomains

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoDomain

HybridoDomain
RealFlowNode

 

The node

 

GetMatchingHybridoEmitters

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoEmitter

HybridoEmitter
RealFlowNode

 

The node

 

GetMatchingHybridoFoams

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoFoam

HybridoFoam
RealFlowNode

 

The node

 

GetMatchingHybridoMeshes

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoMesh

HybridoMesh
RealFlowNode

 

The node

 

GetMatchingHybridoMeshes_VDB

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoMesh_VDB

HybridoMesh_VDB
RealFlowNode

 

The node

 

GetMatchingHybridoMists

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoMist

HybridoMist
RealFlowNode

 

The node

 

GetMatchingHybridoSplashAndFoams

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoSplashAndFoam

HybridoSplashAndFoam
RealFlowNode

 

The node

 

GetMatchingHybridoSplashs

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoSplash

HybridoSplash
RealFlowNode

 

The node

 

GetMatchingHybridoWaterLines

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoWaterLine

HybridoWaterLine
RealFlowNode

 

The node

 

GetMatchingHybridoWetAndFoams

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoWetAndFoam

HybridoWetAndFoam
RealFlowNode

 

The node

 

GetMatchingHybridoWets

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 HybridoWet

HybridoWet
RealFlowNode

 

The node

 

GetMatchingIdocs

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 Idoc

IDOC
RealFlowNode

 

The node

 

GetMatchingMultiBodies

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 MultiBody

MultiBody
RealFlowNode

 

The node

 

GetMatchingMultiJoints

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 MultiJoint

MultiJoint
RealFlowNode

 

The node

 

GetMatchingMultiServoPosAngulars

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 MultiServoPosAngular

MultiServoPosAngular
RealFlowNode

 

The node

 

GetMatchingMultiServoPosLinears

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 MultiServoPosLinear

MultiServoPosLinear
RealFlowNode

 

The node

 

GetMatchingMultiServoVelAngulars

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 MultiServoVelAngular

MultiServoVelAngular
RealFlowNode

 

The node

 

GetMatchingMultiServoVelLinears

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 MultiServoVelLinear

MultiServoVelLinear
RealFlowNode

 

The node

 

GetMatchingObjects

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 Object

Object
RealFlowNode

 

The node

 

GetMatchingParticleLegacyMeshes

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 ParticleLegacyMesh

ParticleLegacyMesh
RealFlowNode

 

The node

 

GetMatchingParticleMeshes

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 ParticleMesh

ParticleMesh
RealFlowNode

 

The node

 

GetMatchingParticleMeshes_VDB

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 ParticleMesh_VDB

ParticleMesh_VDB
RealFlowNode

 

The node

 

GetMatchingRealFlowGroups

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 RealFlowGroup

RealFlowGroup
RealFlowNode

 

The node

 

GetMatchingRealFlowNodes

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

 

GetMatchingSplineNodes

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 SplineNode

SplineNode
RealFlowNode

 

The node

 

GetMatchingStandardEmitters

This node returns the scene nodes that match the input 'name' using wildcard symbols '*' and '?'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The wildcard pattern

Outputs

NameTypesPassThroughDescription
node
 StandardEmitter

StandardEmitter
RealFlowNode

 

The node

 

GetMultiBody

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 MultiBody

MultiBody
RealFlowNode

 

The node

 

GetMultiBodyInfo

This node returns information about the input multi-body.

Inputs

NameTypesPassThroughDescription
multi body nodeMultiBody 

The multi body node

Outputs

NameTypesPassThroughDescription
no of itemsInteger 

The no of items

boxBox 

The box

embeddedBit 

The embedded

 

GetMultiBodyTransformation

This node returns an array of transformation matrices for all items within a MultiBody.

Inputs

NameTypesPassThroughDescription
multi body
 MultiBody (1)

MultiBody
RealFlowNode

 

The multi body

Outputs

NameTypesPassThroughDescription
object global matrixMatrix4 

The object global matrix

object local matrixMatrix4 

The object local matrix

 

GetMultiJoint

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 MultiJoint

MultiJoint
RealFlowNode

 

The node

 

GetMultiServoPosAngular

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 MultiServoPosAngular

MultiServoPosAngular
RealFlowNode

 

The node

 

GetMultiServoPosLinear

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 MultiServoPosLinear

MultiServoPosLinear
RealFlowNode

 

The node

 

GetMultiServoVelAngular

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 MultiServoVelAngular

MultiServoVelAngular
RealFlowNode

 

The node

 

GetMultiServoVelLinear

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 MultiServoVelLinear

MultiServoVelLinear
RealFlowNode

 

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

NameTypesPassThroughDescription
nodeRealFlow Nodethrough

The node

resource idInteger 

The id of the resource to check

option nameString 

The name of the check option within the export resource. It is not case sensitive

Outputs

NameTypesPassThroughDescription
checkBit 

True if check option is enabled

throughPassThroughnode

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

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

descriptionString 

The description of the export resource to get the id from. It is not case-sensitive

Outputs

NameTypesPassThroughDescription
resource idInteger 

The id of the export resource from the input 'node' that matches the input 'description'. -1 otherwise

existsBit 

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

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

resource idInteger 

The id of the resource to check

Outputs

NameTypesPassThroughDescription
existsBit 

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

activeBit 

True if the resource export is enabled

nameString 

The name of the exported resource. Typically, it is the same for all resources in a node

pathString 

The path of the exported resource

descriptionString 

The description of the exported resource

extensionString 

The file extension used by the exported resource

has optionsBit 

True if the exported resource has extra options. An example of resource options is the Compression of an Alembic export resource

optionString 

The option selected for the exported resource. An empty string if the exported resource does not accept options

has check optionsBit 

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

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

Outputs

NameTypesPassThroughDescription
nameString 

The name

 

GetNodeParameter

This node returns the value of the input 'node' parameter.

Only the compatible output values are actually modified.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

parameterString (1) 

The parameter

Outputs

NameTypesPassThroughDescription
stringString 

The string value of the parameter in case the parameter is of the string type

number
 Numeric

Integer
Integer64
Real
Vector3
Color4
ColorGradient
Quaternion
Matrix4

 

The number value of the parameter in case the parameter is of number type

bitBit 

The bit

node valueRealFlow Node 

The boolean value of the parameter in case the parameter is of boolean type

typeParameterType 

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

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

parameterString 

The parameter

Outputs

NameTypesPassThroughDescription
typeParameterType 

The parameter type

 

GetObject

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 Object

Object
RealFlowNode

 

The node

 

GetParticleLegacyMesh

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 ParticleLegacyMesh

ParticleLegacyMesh
RealFlowNode

 

The node

 

GetParticleMesh

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 ParticleMesh

ParticleMesh
RealFlowNode

 

The node

 

GetParticleMesh_VDB

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 ParticleMesh_VDB

ParticleMesh_VDB
RealFlowNode

 

The node

 

GetRealFlowGroup

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 RealFlowGroup

RealFlowGroup
RealFlowNode

 

The node

 

GetRealFlowNode

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

 

GetRealFlowNodeGlobalVariable

This node returns a reference to previously stored variables in global memory (using the SetGlobalVariable-Nodes).

Inputs

NameTypesPassThroughDescription
nameString (1) 

The name

Outputs

NameTypesPassThroughDescription
outRealFlow 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

NameTypesPassThroughDescription
meshRealWaveMesh (1) 

The mesh

search radiusReal (1) 

The search radius

border epsilonReal (1) 

The border epsilon

image resolutionInteger (1) 

The image resolution

color scaleReal (1) 

The color scale

tiledBit (1) 

The tiled

Outputs

NameTypesPassThroughDescription
out imageImage 

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

NameTypesPassThroughDescription
vectorVector3
 Optional

out vector

The vector

meshRealWaveMesh 

The mesh

search radiusReal 

The search radius

Outputs

NameTypesPassThroughDescription
out vectorVector3
 Optional

vector

The out vector

 

GetRealWaveInfo

This node returns information about the RealWave.

Inputs

NameTypesPassThroughDescription
meshRealWaveMesh (1) 

The mesh

Outputs

NameTypesPassThroughDescription
no of verticesInteger 

The no of vertices

no of trianglesInteger 

The no of triangles

bounding boxBox 

The bounding box

initial dimensionBox 

The initial dimension

 

GetRealWaveMesh

This object returns a reference to the RealWave mesh.

Outputs

NameTypesPassThroughDescription
meshRealWaveMesh 

The mesh

 

GetSelectedNodes

This node returns the selected nodes in the scene.

Outputs

NameTypesPassThroughDescription
nodesRealFlow Node 

The nodes

 

GetSplineNode

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 SplineNode

SplineNode
RealFlowNode

 

The node

 

GetStandardEmitter

This node returns the scene node that matches exactly the input 'name'.

It is case sensitive.

Inputs

NameTypesPassThroughDescription
nameString 

The name

Outputs

NameTypesPassThroughDescription
node
 StandardEmitter

StandardEmitter
RealFlowNode

 

The node

 

GetTransformation

This node returns all transformations of the input 'node'.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

Outputs

NameTypesPassThroughDescription
matrixMatrix4 

The matrix

positionVector3 

The position

rotationVector3 

The rotation

scaleVector3 

The scale

shearVector3 

The shear

pivotVector3 

The pivot

 

NodeEnableExportData

This node changes the input 'node' active state for exporting data.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Nodeout node

The node

enableBit 

True to allow data export from the input node

Outputs

NameTypesPassThroughDescription
out nodePassThroughnode

The out node

 

NodeExportDataIsActive

This node returns the input 'node' active state for exporting data.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Nodethrough

The node

Outputs

NameTypesPassThroughDescription
activeBit 

True if the node is allowed to export data

throughPassThroughnode

The input 'node'

 

RealFlowGroupAddMember

This node adds members to the input RealFlow scene Group.

Inputs

NameTypesPassThroughDescription
group
 RealFlowGroup

RealFlowGroup
RealFlowNode

out group

Group to add the node to

nodeRealFlow Node 

Node or group to add to the input group

Outputs

NameTypesPassThroughDescription
out groupPassThroughgroup

The out group

 

RealFlowGroupGetMembers

This node returns members from the input RealFlow scene Group.

Inputs

NameTypesPassThroughDescription
group
 RealFlowGroup (1)

RealFlowGroup
RealFlowNode

through

Group to get the nodes from

recursiveBit (1) 

True to expand groups that belong to the input group

Outputs

NameTypesPassThroughDescription
nodesRealFlow Node 

Nodes that belong to the group

throughPassThroughgroup

The input 'group'

 

RealFlowGroupRemoveMember

This node removes members from the input RealFlow scene Group.

Inputs

NameTypesPassThroughDescription
group
 RealFlowGroup

RealFlowGroup
RealFlowNode

out group

Group to remove the node from

nodeRealFlow Node 

Node or group to remove from the input group

Outputs

NameTypesPassThroughDescription
out groupPassThroughgroup

The out group

 

RealWaveIndexToPos

Returns the world coordinates of RealWave vertices given by index.

Inputs

NameTypesPassThroughDescription
indexInteger 

The index

meshRealWaveMesh 

The mesh

Outputs

NameTypesPassThroughDescription
vectorVector3 

The vector

 

RealWaveIndexToUV

Returns the uv's of RealWave vertices given by index.

Inputs

NameTypesPassThroughDescription
indexInteger 

The index

meshRealWaveMesh 

The mesh

Outputs

NameTypesPassThroughDescription
vectorVector3 

The vector

 

RealWaveMeshUpdate

Refreshes the actual states of the RealWave mesh.

Inputs

NameTypesPassThroughDescription
meshRealWaveMeshout mesh

The mesh

face normalsBit (1) 

The face normals

vertex upBit (1) 

The vertex up

vertex normalsBit (1) 

The vertex normals

bounding boxBit (1) 

The bounding box

depth mapBit (1) 

The depth map

Outputs

NameTypesPassThroughDescription
out meshRealWaveMeshmesh

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

NameTypesPassThroughDescription
mesh inRealWaveMesh 

RealWave Mesh

positionVector3 (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

rotationReal (1) 

The orientation of influence. Using this paramater, you may rotate the waves orientation around the y-axis

widthReal (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

radiusReal (1) 

The radius of influence. Within this axis-radius, the rigging is fullfilled

intensityReal (1) 

The intensity of rigging. Higher values mean higher intensities

intensity smoothInteger (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
 List

curve
linear
quadratic
inv.quadratic

 

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 widthReal (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
 List

curve
linear
quadratic
inv.quadratic

 

Similar to 'l falldown func'

r falldown widthReal (1) 

Similar to 'l falldown width'

anti spiral enableBit (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 angleReal (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 curveReal (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 enableBit (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 centerVector3 (1) 

The center of the radial wave

radial fade angleReal (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 startReal (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 threshReal (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 offsReal (1) 

A y-threshold which is added to the emitter position. Might be helpful in some circumstances

emit velReal (1) 

Defines the emitters absolute velocity. Should depend on the speed of the wave

emit vel angleReal (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 jitterReal (1) 

Add jittering to the particle creation positions, to reduce visible patterns within the created particles. 

Outputs

NameTypesPassThroughDescription
mesh outRealWaveMesh 

The new real wave mesh, including the deformation

emitter posVector3 

The position of newly created particles at the wave peak. To use them within your scene, you may use the 'addParticle'-Node

emitter velVector3 

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

NameTypesPassThroughDescription
arrayRealFlow Node
 Optional

result

The array

indexInteger 

The index

elementRealFlow Node 

The element

Outputs

NameTypesPassThroughDescription
resultRealFlow Node
 Optional

array

The result

 

SetMultiBodyTransformation

This node changes the global transformation matrix of the bodies of the input MultiBody 'node' to the given input matrix.

The 'mask' parameter can be used to determine which body transformation needs to be changed.

Inputs

NameTypesPassThroughDescription
node
 MultiBody

MultiBody
RealFlowNode

 

The node

maskBit 

If connected, the true bits of the mask determine which objects from the MultiBody will be modified

matrixMatrix4 

The new global matrix for the MultiBody object

Outputs

NameTypesPassThroughDescription
throughPassThrough 

The through

 

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

NameTypesPassThroughDescription
nodeRealFlow Nodeout node

The node

resource idInteger 

The id of the resource to check

option nameString 

The name of the check option of the export resource. It is not case sensitive

checkBit 

True to enable the check option

Outputs

NameTypesPassThroughDescription
out nodePassThroughnode

The out node

 

SetNodeExportResourceValue

This node changes the information related to an export resource of the input 'node'.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Nodeout node

The node

resource idInteger 

The id of the resource to check

enableBit 

True to enable the export resource

nameString 

The name of the exported resource

pathString 

The path of the exported resource

optionString 

The option to set for the exported resource. It is not case-sensitive

Outputs

NameTypesPassThroughDescription
out nodePassThroughnode

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

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

nameString 

The name

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

 

SetNodeParameter

This node changes the value of the input 'node' parameter.

Only the compatible input values are actually taken into account.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Nodeout node

The node

parameterString (1) 

The parameter

string valueString 

The string value for the parameter in case the parameter is of the string type

number value
 Numeric

Integer
Integer64
Real
Vector3
Color4
ColorGradient
Quaternion
Matrix4

 

The number value for the parameter in case the parameter is of number type

bit valueBit 

The bit value

node valueRealFlow Node 

The node value for the parameter in case the parameter is of node type

Outputs

NameTypesPassThroughDescription
out nodePassThroughnode

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

NameTypesPassThroughDescription
nameString (1) 

The name

inRealFlow Nodethrough

The in

store copyBit (1) 

The store copy

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The value connected to the input

out copyRealFlow 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

NameTypesPassThroughDescription
positionsVector3 

The new position of the vertex in world space

idsInteger 

The ids

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

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

NameTypesPassThroughDescription
imageImage (1) 

The image. Its bit depth must be 32 bit

meshRealWaveMesh (1)out mesh

The mesh

scale xyzVector3 (1) 

The scale xyz

tiledBit (1) 

The tiled

Outputs

NameTypesPassThroughDescription
out meshRealWaveMeshmesh

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

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

translationVector3 

The translation

rotationVector3 

The rotation

scaleVector3 

The scale

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

 

SetTransformationFromMatrix

This node changes the local transformation matrix of the input 'node' to the given input matrix.

.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

matrixMatrix4 

The matrix

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate