Scene

This group contains everything you need to read out the current frame and time, keep track of the simulation's current settings, and trigger the simulation. Many nodes also allow you to add objects. Please bear in mind that objects should not be created at simulation time, because they may behave incorrectly. The best and safest way is to add them with a batch graph before the simulation starts. You can not only add RealFlow's native polygon objects, but also any other node type: emitters, Hybrido domains, secondary particle emitters, meshes, daemons, and so on.

Nodes

NameDescription
ExportCurrentFrameThis node exports ALL the enabled resources on the Export Central the same way they would do during a simulation.
GetAllSceneExportResourceOptionsThis node returns all the export resource options allowed for the input 'resource id'.
GetAllSceneExportResourcesThis node returns all the export resource identifiers and descriptions. It is especially useful in combination with the rest of the 'Get/SetSceneExportResource' nodes.
GetAllSceneVariableNamesThis node returns all the scene variable names stored in RealFlow.
GetCommandLineSimulationOptionsThis node returns the command line simulation parameters of the scene.
GetCurrentFrameTimeThis node returns the time and frame according to the current status of the RealFlow scene.
GetDyversoSimulationOptionsThis node returns the Dyverso simulation parameters of the scene.
GetFrameRangeThis node returns the frame settings according to the current status of the RealFlow scene.
GetMaxwellIBLParametersThis node returns the Maxwell Render image-based lighting parameters.
GetMaxwellParametersThis node returns the Maxwell Render parameters.
GetPreferencesAxisThis node returns the actual used axis-system, which can be set in the File->Preferences menu.
GetSceneExportResourceIdFromDescriptionThis node returns all the information related to an export resource of the scene.
GetSceneExportResourceInfoThis node returns all the information related to an export resource of the scene. If the resource does not exist and the 'exists' output is not connected, an error message is displayed.
GetSceneVariableThis node returns the scene variable value stored in RealFlow.
GetSimulationOptionsThis node returns the simulation parameters of the scene.
MaxwellRenderRestartThis node forces a full restart of Maxwell Render interactive preview if it is running.
MaxwellRenderStopThis node stops Maxwell Render interactive preview if it is running.
ObjectSetMeshThis node replaces an existing object mesh with the input one.
SceneAddCameraThis node adds a new Camera to the scene.
SceneAddDaemonThis node adds a new daemon of the specified type to the scene.
SceneAddDefaultHubLinkThis node creates a direct link between the given scene node and the default hub.
SceneAddDyversoDomainThis node adds a new DyversoDomain to the scene.
SceneAddDyversoEmitterThis node adds a new DyversoEmitter to the scene.
SceneAddHubThis node creates a new link hub.
SceneAddHubLinkThis node creates a direct link between the given node and hub names.
SceneAddHybridoBubblesThis node adds a new HybridoBubbles to the scene.
SceneAddHybridoDomainThis node adds a new HybridoDomain to the scene.
SceneAddHybridoEmitterThis node adds a new HybridoEmitter to the scene.
SceneAddHybridoFoamThis node adds a new HybridoFoam to the scene.
SceneAddHybridoMeshThis node adds a new HybridoMesh to the scene.
SceneAddHybridoMistThis node adds a new HybridoMist to the scene.
SceneAddHybridoSplashThis node adds a new HybridoSplash to the scene.
SceneAddHybridoSplashAndFoamThis node adds a new HybridoSplashAndFoam to the scene.
SceneAddHybridoWaterLineThis node adds a new HybridoWaterLine to the scene.
SceneAddHybridoWetThis node adds a new HybridoWet to the scene.
SceneAddHybridoWetAndFoamThis node adds a new HybridoWetAndFoam to the scene.
SceneAddIdocThis node adds a new Idoc to the scene.
SceneAddLinkThis node creates a direct link between the given node or hub names.
SceneAddMultiBodyThis node imports the input 'file path' as a MultiBody node and adds it to the RealFlow scene.
SceneAddMultiBodyFromMeshThis node adds a new multi body containing the input meshes.
SceneAddMultiJointThis node adds a new MultiJoint to the scene.
SceneAddMultiServoPosAngularThis node adds a new MultiServoPosAngular to the scene.
SceneAddMultiServoPosLinearThis node adds a new MultiServoPosLinear to the scene.
SceneAddMultiServoVelAngularThis node adds a new MultiServoVelAngular to the scene.
SceneAddMultiServoVelLinearThis node adds a new MultiServoVelLinear to the scene.
SceneAddObjectThis node adds a new object of the specified type to the scene.
SceneAddObjectFromMeshThis node adds a new object from the input mesh.
SceneAddParticleLegacyMeshThis node adds a new ParticleLegacyMesh to the scene.
SceneAddParticleMeshThis node adds a new ParticleMesh to the scene.
SceneAddRealFlowGroupThis node adds a new RealFlowGroup to the scene.
SceneAddStandardEmitterThis node adds a new RealFlow Standard Emitter to the scene. The concrete type is specified by the input.
SceneDefaultHubNameThis node returns the name of the default hub of the scene.
SceneExistsHubThis node checks if there is a hub link with the requested name in the scene.
SceneExistsLinkThis node checks if there is a link between 'source' and 'target'.
SceneGetAllHubsThis node returns the name of all the hubs in the scene.
SceneGetHubLinksThis node returns all the links with the input hub.
SceneGetNodeLinksThis node returns the links with the input node or hub.
SceneImageCurrentViewportThis node creates a screenshot of the current RealFlow active viewport.
SceneImportObjectsThis node imports objects from the input 'file path' and adds them to the RealFlow scene.
SceneInterfaceEnableUpdatesThis node enables or disables RealFlow user interface updates.
SceneInterfaceIsUpdatesEnabledThis node checks if RealFlow user interface updates are enabled.
SceneIsLinkAllowedThis node checks if the direct link between 'source' and 'target' is allowed.
SceneMaxwellRenderToImageThis node renders the current state of the scene from the input camera point of view.
SceneNewThis node creates a new scene, prompting the user to remove the current changes.
ScenePaintThis node enables again viewport painting and forces a repaint of RealFlow OpenGL viewport.
ScenePaintEnableThis node enables or disables RealFlow OpenGL viewport updates.
SceneRemoveHubThis node removes an existing hub.
SceneRemoveLinkThis node removes an existing direct link between the given node or hub names.
SceneRemoveNodeThis node removes any node from the scene.
SceneRenameHubThis node renames an existing hub.
SceneResetThis node resets the current RealFlow scene.
SceneSelectNodeThis node selects the input 'nodes' of RealFlow scene.
SceneUpdateInterfaceThis node forces an update of RealFlow user interface.
SceneUpdateTimeLineCacheThis node updates the time line of RealFlow - similar to selecting "Export->Update Time Line Cache".
SceneVariableResolveThis node returns a version of the input string with all its contained scene variables resolved.
SetCommandLineSimulationOptionsThis node lets the user modify the scene command line simulation options.
SetCurrentFrameThis node changes the current frame of the RealFlow scene.
SetDyversoSimulationOptionsThis node lets the user modify the scene Dyverso simulation options.
SetMaxFramesThis node changes the maximum frames in the RealFlow scene.
SetMaxwellIBLParametersThis node sets the Maxwell Render image-based lighting parameters.
SetMaxwellParametersThis node sets the Maxwell Render parameters.
SetSceneExportResourceValueThis node changes the information related to an export resource of the scene. Take note, the export resource must betyped with according brackets, e.g., 'Animation (.sd)'.
SetSceneVariableThis node sets the scene variable value stored in RealFlow.
SetSimulationOptionsThis node returns the simulation parameters of the scene.
SimulateThis node starts the simulation of the current RealFlow scene.
SimulateRangeThis node starts the simulation of the current RealFlow scene from the 'start' frame to the 'stop' frame.
SimulateStepThis node performs a simulation step. 'status' value is set to SIM_STATUS_FRAME_IS_UP(0) if we are in a new frame after the cycle; SIM_STATUS_FINISHED(1) if we reach the scene last frame after the cycle; SIM_STATUS_NORMAL(2) when nothing happened.
SimulationStopThis node stops the current RealFlow simulation, if the input 'condition' is 'true'.

 

ExportCurrentFrame

This node exports ALL the enabled resources on the Export Central the same way they would do during a simulation.

This means that nodes in Cache state may not overwrite their data.

Inputs

NameTypesPassThroughDescription
inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

GetAllSceneExportResourceOptions

This node returns all the export resource options allowed for the input 'resource id'.

An example of export resource option is the 'Image sequence (*)' filetype: ['tga','bmp', ... ].

Inputs

NameTypesPassThroughDescription
resource idInteger (1) 

The id of the scene export resource

Outputs

NameTypesPassThroughDescription
optionsString 

The options allowed by the input export resource

current valueString 

The current option value

 

GetAllSceneExportResources

This node returns all the export resource identifiers and descriptions. It is especially useful in combination with the rest of the 'Get/SetSceneExportResource' nodes.

Outputs

NameTypesPassThroughDescription
resource idInteger 

The id of the export resource

descriptionString 

The description of the export resource

 

GetAllSceneVariableNames

This node returns all the scene variable names stored in RealFlow.

A scene variable is a global string variable usually used for path composition with $(MACRONAME). Examples of scene variable names are SCENEDIR or IDOC.

Outputs

NameTypesPassThroughDescription
namesString 

The names of the scene variables currently stored in RealFlow

 

GetCommandLineSimulationOptions

This node returns the command line simulation parameters of the scene.

Outputs

NameTypesPassThroughDescription
command line simulationBit 

Perform simulation on Command Line

frame beginInteger 

Frame begin

frame endInteger 

Frame end

same range as sceneBit 

Use current scene frame range

threadsInteger 

Number of threads

same threads as sceneBit 

Use current scene number of threads

resetBit 

Reset command line flag

use cacheBit 

Use Cache command line flag

meshBit 

Mesh command line flag

 

GetCurrentFrameTime

This node returns the time and frame according to the current status of the RealFlow scene.

Outputs

NameTypesPassThroughDescription
timeReal 

The current time value of the scene

frameInteger 

The current frame of the scene

 

GetDyversoSimulationOptions

This node returns the Dyverso simulation parameters of the scene.

Outputs

NameTypesPassThroughDescription
time scaleReal 

Time scale

stepping strictnessReal 

Stepping strictness

max neighborsInteger 

Max neighbors

dynamic search radiiBit 

Dynamic search radii

use geometry velocityBit 

Use geometry velocity

opencl cpuBit 

Use OpenCL-CPU

opencl gpuBit 

Use OpenCL-GPU

opencl gpu deviceInteger 

OpenCL-GPU device ID

cuda gpuBit 

Use CUDA-GPU

cuda gpu deviceInteger 

CUDA-GPU device ID

liquid pbd min substepsInteger 

Liquid PBD - minimum substeps

liquid pbd max substepsInteger 

Liquid PBD - maximum substeps

liquid pbd min iterationsInteger 

Liquid PBD - minimum iterations

liquid pbd max iterationsInteger 

Liquid PBD - maximum iterations

liquid pbd accuracyReal 

Liquid PBD - Accuracy

liquid sph min substepsInteger 

Liquid SPH - minimum substeps

liquid sph max substepsInteger 

Liquid SPH - maximum substeps

granular min substepsInteger 

Granular - minimum substeps

granular max substepsInteger 

Granular - maximum substeps

granular iterationsInteger 

Granular - iterations

viscous min substepsInteger 

Viscous - minimum substeps

viscous max substepsInteger 

Viscous - maximum substeps

viscous iterationsInteger 

Viscous - iterations

viscoelastic min substepsInteger 

Viscoelastic - minimum substeps

viscoelastic max substepsInteger 

Viscoelastic - maximum substeps

viscoelastic iterationsInteger 

Viscoelastic - iterations

rigid min substepsInteger 

Rigid - minimum substeps

rigid max substepsInteger 

Rigid - maximum substeps

rigid iterationsInteger 

Rigid - iterations

elastic min substepsInteger 

Elastic - minimum substeps

elastic max substepsInteger 

Elastic - maximum substeps

elastic iterationsInteger 

Elastic - iterations

dumb min substepsInteger 

Dumb - minimum substeps

dumb max substepsInteger 

Dumb - maximum substeps

 

GetFrameRange

This node returns the frame settings according to the current status of the RealFlow scene.

Outputs

NameTypesPassThroughDescription
frame currentInteger 

The current frame

frame lastInteger 

The last frame of the scene

frame beginInteger 

The first frame of the current animation

frame endInteger 

The last frame of the current animation

 

GetMaxwellIBLParameters

This node returns the Maxwell Render image-based lighting parameters.

Inputs

NameTypesPassThroughDescription
layer
 List

Background
Illumination
Reflection
Refraction

 

The layer

Outputs

NameTypesPassThroughDescription
file path
 FilePath

FilePath
String

 

The file path

intensityReal 

The intensity

tile uReal 

The tile u

tile vReal 

The tile v

offset uReal 

The offset u

offset vReal 

The offset v

 

GetMaxwellParameters

This node returns the Maxwell Render parameters.

Outputs

NameTypesPassThroughDescription
intensityReal 

Intensity

lightInteger 

Light. From 0 to 99, being 0 the 5:00h, and 99 the 19:00h

sun rotationReal 

Sun rotation in degrees, from 0 to 360

physical skyBit 

Use physical sky

qualityInteger 

Quality

no of threadsInteger 

Number of threads

max frame timeInteger 

Maximum frame render time. In seconds. This setting only affects the preview process

max sampling levelInteger 

Maximum sampling level. This setting only affects the preview process

motion blurInteger 

Motion blur factor. This setting only affects the preview process

global scaleReal 

Global scale

production engineBit 

Use draft engine. False to use the draft engine, true to use the production engine. This setting only affects the preview process

use iblBit 

The use ibl

ibl illumination same as backgroundBit 

The ibl illumination same as background

ibl reflection same as backgroundBit 

The ibl reflection same as background

ibl refraction same as backgroundBit 

The ibl refraction same as background

export alpha channelBit 

The export alpha channel

export motion channelBit 

The export motion channel

export normals channelBit 

The export normals channel

 

GetPreferencesAxis

This node returns the actual used axis-system, which can be set in the File->Preferences menu.

Outputs

NameTypesPassThroughDescription
axis id for reorderInteger 

Returns an id which can be used within the 'vector3Reorder' node:

1 - YXZ (Lightwave, cinema4d)

3 - ZXY (3dsmax, maya)

2 - YZX (xsi, maya, houdini)

 

axis idInteger 

Returns an id according to the axis preferences:

0 - YXZ (Lightwave, cinema4d)

1 - ZXY (3dsmax, maya)

2 - YZX (xsi, maya, houdini)

 

 

GetSceneExportResourceIdFromDescription

This node returns all the information related to an export resource of the scene.

Inputs

NameTypesPassThroughDescription
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

 

GetSceneExportResourceInfo

This node returns all the information related to an export resource of the scene. If the resource does not exist and the 'exists' output is not connected, an error message is displayed.

Inputs

NameTypesPassThroughDescription
resource idInteger 

The id of the resource to check

Outputs

NameTypesPassThroughDescription
existsBit 

True if the resource exists for the scene. False otherwise. An error message will be displayed if this output is not connected and the resource does not exist

activeBit 

True if the resource export is enabled

nameString 

The name of the exported resource

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 image format

optionString 

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

 

GetSceneVariable

This node returns the scene variable value stored in RealFlow.

A scene variable is a global string variable usually used for path composition with $(MACRONAME). Examples of scene variable names are SCENEDIR or IDOC.

Inputs

NameTypesPassThroughDescription
nameString 

The name of the scene variable

Outputs

NameTypesPassThroughDescription
valueString 

The value of the scene variable. An empty string if it does not exist

 

GetSimulationOptions

This node returns the simulation parameters of the scene.

Outputs

NameTypesPassThroughDescription
fpsInteger 

Frames per Second

no of threadsInteger 

Number of Threads

use max threadsBit 

Use max. threads

master min substepsInteger 

Master MIN substeps

master max substepsInteger 

Master MAX substeps

hybrido time scaleInteger 

Hybrido Time Scale

hybrido min substepsInteger 

Hybrido MIN substeps

hybrido max substepsInteger 

Hybrido MAX substeps

hybrido strictnessReal 

Hybrido Strictness

pressure max iterationsInteger 

Pressure Solver MAX iterations

pressure accuracyReal 

Pressure Solver Accuracy

viscosity max iterationsInteger 

Viscosity Solver MAX iterations

viscosity accuracyReal 

Viscosity Solver Accuracy

hybr 2nd solver min substInteger 

Hybrido Secondary Solver - Stepping - MIN substeps

hybr 2nd solver max substInteger 

Hybrido Secondary Solver - Stepping - MAX substeps

transport particle stepsInteger 

Transport Particle Steps

hybrido collision face areaBit 

Face area Hybrido collision fractions computation mode

hybrido collision supersamplingBit 

Supersampling Hybrido collision fractions computation mode

hybrido collision samplesInteger 

Supersampling Hybrido collision fractions computation mode number of samples

use opencl-cpuBit 

Use OpenCL-CPU

use opencl-gpuBit 

Use OpenCL-GPU

use opencl-accBit 

Use OpenCL-ACC

caronte qualityInteger 

Caronte Quality

caronte anti-jitterInteger 

Caronte Anti-Jitter

caronte properties overrideBit 

Characteristic object properties - Override

caronte properties thicknessReal 

Characteristic object properties - Thickness

caronte properties lengthReal 

Characteristic object properties - Length

geometry scaleReal 

The geometry scale

cell size scaleReal 

The cell size scale

daemon force scale for fluidsReal 

The daemon force scale for fluids

daemon force scale for objectsReal 

The daemon force scale for objects

reset to initial stateBit 

Reset to Initial State flag

 

MaxwellRenderRestart

This node forces a full restart of Maxwell Render interactive preview if it is running.

Inputs

NameTypesPassThroughDescription
restartBit (1) 

True to actually restart the render. False to act like a passthrough

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

MaxwellRenderStop

This node stops Maxwell Render interactive preview if it is running.

Inputs

NameTypesPassThroughDescription
stopBit (1) 

True to actually stop the render. False to act like a passthrough

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

ObjectSetMesh

This node replaces an existing object mesh with the input one.

Inputs

NameTypesPassThroughDescription
object
 Object

Object
RealFlowNode

out object

The object

meshMesh 

The mesh

Outputs

NameTypesPassThroughDescription
out objectPassThroughobject

The out object

 

SceneAddCamera

This node adds a new Camera to the scene.

Outputs

NameTypesPassThroughDescription
camera
 Camera

Camera
RealFlowNode

 

The new Camera

 

SceneAddDaemon

This node adds a new daemon of the specified type to the scene.

Inputs

NameTypesPassThroughDescription
type
 List
 
 

The type

Outputs

NameTypesPassThroughDescription
daemon
 Daemon

Daemon
RealFlowNode

 

The daemon

 

This node creates a direct link between the given scene node and the default hub.

If the link already exists the return value is false.

Inputs

NameTypesPassThroughDescription
node nameString 

Name of node to add to the default hub

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
okBit 

True if the link was created. False otherwise

throughPassThroughin

The input 'in'

 

SceneAddDyversoDomain

This node adds a new DyversoDomain to the scene.

Outputs

NameTypesPassThroughDescription
dyverso domain
 DyversoDomain

DyversoDomain
RealFlowNode

 

The new DyversoDomain

 

SceneAddDyversoEmitter

This node adds a new DyversoEmitter to the scene.

Outputs

NameTypesPassThroughDescription
dyverso emitter
 DyversoEmitter

DyversoEmitter
RealFlowNode

 

The new DyversoEmitter

 

SceneAddHub

This node creates a new link hub.

Inputs

NameTypesPassThroughDescription
inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
hubString 

The name of the created hub

throughPassThroughin

The input 'in'

 

This node creates a direct link between the given node and hub names.

If the link already exists the return value is false.

Inputs

NameTypesPassThroughDescription
node nameString 

Name of node to add to the hub

hubString 

Name of hub to create the link with

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
okBit 

True if the link was created. False otherwise

throughPassThroughin

The input 'in'

 

SceneAddHybridoBubbles

This node adds a new HybridoBubbles to the scene.

Outputs

NameTypesPassThroughDescription
hybrido bubbles
 HybridoBubbles

HybridoBubbles
RealFlowNode

 

The new HybridoBubbles

 

SceneAddHybridoDomain

This node adds a new HybridoDomain to the scene.

Outputs

NameTypesPassThroughDescription
hybrido domain
 HybridoDomain

HybridoDomain
RealFlowNode

 

The new HybridoDomain

 

SceneAddHybridoEmitter

This node adds a new HybridoEmitter to the scene.

Outputs

NameTypesPassThroughDescription
hybrido emitter
 HybridoEmitter

HybridoEmitter
RealFlowNode

 

The new HybridoEmitter

 

SceneAddHybridoFoam

This node adds a new HybridoFoam to the scene.

Outputs

NameTypesPassThroughDescription
hybrido foam
 HybridoFoam

HybridoFoam
RealFlowNode

 

The new HybridoFoam

 

SceneAddHybridoMesh

This node adds a new HybridoMesh to the scene.

Outputs

NameTypesPassThroughDescription
hybrido mesh
 HybridoMesh

HybridoMesh
RealFlowNode

 

The new HybridoMesh

 

SceneAddHybridoMist

This node adds a new HybridoMist to the scene.

Outputs

NameTypesPassThroughDescription
hybrido mist
 HybridoMist

HybridoMist
RealFlowNode

 

The new HybridoMist

 

SceneAddHybridoSplash

This node adds a new HybridoSplash to the scene.

Outputs

NameTypesPassThroughDescription
hybrido splash
 HybridoSplash

HybridoSplash
RealFlowNode

 

The new HybridoSplash

 

SceneAddHybridoSplashAndFoam

This node adds a new HybridoSplashAndFoam to the scene.

Outputs

NameTypesPassThroughDescription
hybrido splash and foam
 HybridoSplashAndFoam

HybridoSplashAndFoam
RealFlowNode

 

The new HybridoSplashAndFoam

 

SceneAddHybridoWaterLine

This node adds a new HybridoWaterLine to the scene.

Outputs

NameTypesPassThroughDescription
hybrido waterline
 HybridoWaterLine

HybridoWaterLine
RealFlowNode

 

The new HybridoWaterLine

 

SceneAddHybridoWet

This node adds a new HybridoWet to the scene.

Outputs

NameTypesPassThroughDescription
hybrido wet
 HybridoWet

HybridoWet
RealFlowNode

 

The new HybridoWet

 

SceneAddHybridoWetAndFoam

This node adds a new HybridoWetAndFoam to the scene.

Outputs

NameTypesPassThroughDescription
hybrido wet and foam
 HybridoWetAndFoam

HybridoWetAndFoam
RealFlowNode

 

The new HybridoWetAndFoam

 

SceneAddIdoc

This node adds a new Idoc to the scene.

Outputs

NameTypesPassThroughDescription
idoc
 Idoc

IDOC
RealFlowNode

 

The new Idoc

 

This node creates a direct link between the given node or hub names.

If the link already exists the return value is false.

Inputs

NameTypesPassThroughDescription
sourceString 

Name of node or hub to be the source of the link

targetString 

Name of node or hub to be the target of the link

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
okBit 

True if the link was created. False otherwise

throughPassThroughin

The input 'in'

 

SceneAddMultiBody

This node imports the input 'file path' as a MultiBody node and adds it to the RealFlow scene.

Inputs

NameTypesPassThroughDescription
file path
 FilePath

FilePath
String

 

The file path

Outputs

NameTypesPassThroughDescription
multibody
 MultiBody

MultiBody
RealFlowNode

 

The multibody

 

SceneAddMultiBodyFromMesh

This node adds a new multi body containing the input meshes.

Inputs

NameTypesPassThroughDescription
meshMesh 

The mesh

Outputs

NameTypesPassThroughDescription
node
 MultiBody

MultiBody
RealFlowNode

 

The node

 

SceneAddMultiJoint

This node adds a new MultiJoint to the scene.

Outputs

NameTypesPassThroughDescription
multi joint
 MultiJoint

MultiJoint
RealFlowNode

 

The new MultiJoint

 

SceneAddMultiServoPosAngular

This node adds a new MultiServoPosAngular to the scene.

Outputs

NameTypesPassThroughDescription
multi servo pos angular
 MultiServoPosAngular

MultiServoPosAngular
RealFlowNode

 

The new MultiServoPosAngular

 

SceneAddMultiServoPosLinear

This node adds a new MultiServoPosLinear to the scene.

Outputs

NameTypesPassThroughDescription
multi servo pos linear
 MultiServoPosLinear

MultiServoPosLinear
RealFlowNode

 

The new MultiServoPosLinear

 

SceneAddMultiServoVelAngular

This node adds a new MultiServoVelAngular to the scene.

Outputs

NameTypesPassThroughDescription
multi servo vel angular
 MultiServoVelAngular

MultiServoVelAngular
RealFlowNode

 

The new MultiServoVelAngular

 

SceneAddMultiServoVelLinear

This node adds a new MultiServoVelLinear to the scene.

Outputs

NameTypesPassThroughDescription
multi servo vel linear
 MultiServoVelLinear

MultiServoVelLinear
RealFlowNode

 

The new MultiServoVelLinear

 

SceneAddObject

This node adds a new object of the specified type to the scene.

Inputs

NameTypesPassThroughDescription
type
 List

null
sphere
hemisphere
cube
cube top open
cylinder
vase
cone
plane
torus
rocket
capsule
cross

 

The type

Outputs

NameTypesPassThroughDescription
object
 Object

Object
RealFlowNode

 

The object

 

SceneAddObjectFromMesh

This node adds a new object from the input mesh.

Inputs

NameTypesPassThroughDescription
meshMesh 

The mesh

Outputs

NameTypesPassThroughDescription
object
 Object

Object
RealFlowNode

 

The object

 

SceneAddParticleLegacyMesh

This node adds a new ParticleLegacyMesh to the scene.

Outputs

NameTypesPassThroughDescription
legacy mesh
 ParticleLegacyMesh

ParticleLegacyMesh
RealFlowNode

 

The new ParticleLegacyMesh

 

SceneAddParticleMesh

This node adds a new ParticleMesh to the scene.

Outputs

NameTypesPassThroughDescription
particle mesh
 ParticleMesh

ParticleMesh
RealFlowNode

 

The new ParticleMesh

 

SceneAddRealFlowGroup

This node adds a new RealFlowGroup to the scene.

Outputs

NameTypesPassThroughDescription
group
 RealFlowGroup

RealFlowGroup
RealFlowNode

 

The new RealFlowGroup

 

SceneAddStandardEmitter

This node adds a new RealFlow Standard Emitter to the scene. The concrete type is specified by the input.

Inputs

NameTypesPassThroughDescription
type
 List
 
 

The type

Outputs

NameTypesPassThroughDescription
emitter
 StandardEmitter

StandardEmitter
RealFlowNode

 

The emitter

 

SceneDefaultHubName

This node returns the name of the default hub of the scene.

Outputs

NameTypesPassThroughDescription
hubString 

The name of the default hub of the scene. The empty string if there are no hubs in the scene

 

SceneExistsHub

This node checks if there is a hub link with the requested name in the scene.

Inputs

NameTypesPassThroughDescription
hubString 

Name of hub to check

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
resultBit 

True if the hub exists. False otherwise

throughPassThroughin

The input 'in'

 

This node checks if there is a link between 'source' and 'target'.

Inputs

NameTypesPassThroughDescription
sourceString 

Name of node or hub to be the source of the link

targetString 

Name of node or hub to be the target of the link

check implicitBit 

True to check also implicit links. False for checking only direct links

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
resultBit 

True if the link exists. False otherwise

throughPassThroughin

The input 'in'

 

SceneGetAllHubs

This node returns the name of all the hubs in the scene.

Outputs

NameTypesPassThroughDescription
hubsString 

The name of the hubs in the scene

 

This node returns all the links with the input hub.

Inputs

NameTypesPassThroughDescription
hubString 

The hub to check the links with

Outputs

NameTypesPassThroughDescription
linksString 

The name of the links to the input hub

 

This node returns the links with the input node or hub.

Inputs

NameTypesPassThroughDescription
nodeString 

Name of node or hub to check the links

is sourceBit 

True to include links where the node is the source

is targetBit 

True to include links where the node is the target

check implicitBit 

True to include implicit links with the given node. False to include only direct links

Outputs

NameTypesPassThroughDescription
linksString 

Nodes linked with the input node

 

SceneImageCurrentViewport

This node creates a screenshot of the current RealFlow active viewport.

Inputs

NameTypesPassThroughDescription
inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
imageImage 

An image containing the current render of the active viewport

throughPassThroughin

The input 'in'

 

SceneImportObjects

This node imports objects from the input 'file path' and adds them to the RealFlow scene.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path

Outputs

NameTypesPassThroughDescription
objects
 Object

Object
RealFlowNode

 

The objects

 

SceneInterfaceEnableUpdates

This node enables or disables RealFlow user interface updates.

Inputs

NameTypesPassThroughDescription
enableBit (1) 

True to enable interface updates. False to disable them

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

SceneInterfaceIsUpdatesEnabled

This node checks if RealFlow user interface updates are enabled.

Inputs

NameTypesPassThroughDescription
inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
enabledBit 

True if interface updates are enabled. False otherwise

throughPassThroughin

The input 'in'

 

SceneIsLinkAllowed

This node checks if the direct link between 'source' and 'target' is allowed.

If the link already exists the return value is still true.

Inputs

NameTypesPassThroughDescription
sourceString 

Name of node or hub to be the source of the link

targetString 

Name of node or hub to be the target of the link

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
resultBit 

True if the link is allowed. False otherwise

throughPassThroughin

The input 'in'

 

SceneMaxwellRenderToImage

This node renders the current state of the scene from the input camera point of view.

If no camera is selected, the current selected view is used.

This nodes does not finish its execution until Maxwell Render completes its render process.

Inputs

NameTypesPassThroughDescription
camera
 Camera

Camera
RealFlowNode

 

The camera to use for the render. If none is connected, render is performed using the selected view

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
imageImage 

An image containing a Maxwell Render of the current frame

throughPassThroughin

The input 'in'

 

SceneNew

This node creates a new scene, prompting the user to remove the current changes.

Outputs

NameTypesPassThroughDescription
cleanedBit 

True if the scene was successfully cleaned. False if user cancelled

 

ScenePaint

This node enables again viewport painting and forces a repaint of RealFlow OpenGL viewport.

If interface updates are disabled th viewport is not updated.

Inputs

NameTypesPassThroughDescription
paintBit (1) 

True to repaint the viewport. False to act like a passthrough

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

ScenePaintEnable

This node enables or disables RealFlow OpenGL viewport updates.

Inputs

NameTypesPassThroughDescription
enableBit (1) 

True to enable OpenGL viewport painting. False to disable it

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

SceneRemoveHub

This node removes an existing hub.

Inputs

NameTypesPassThroughDescription
hubString 

Name of hub to remove

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
okBit 

True if the hub was removed. False otherwise

throughPassThroughin

The input 'in'

 

This node removes an existing direct link between the given node or hub names.

If the link does not exists the return value is false.

Inputs

NameTypesPassThroughDescription
sourceString 

Name of node or hub to be the source of the removed link

targetString 

Name of node or hub to be the target of the removed link

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
okBit 

True if the link was removed. False otherwise

throughPassThroughin

The input 'in'

 

SceneRemoveNode

This node removes any node from the scene.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Node 

The node

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

 

SceneRenameHub

This node renames an existing hub.

Inputs

NameTypesPassThroughDescription
hubString 

Name of hub to rename

new hub nameString 

New name for the hub

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
okBit 

True if the hub was renamed. False otherwise

throughPassThroughin

The input 'in'

 

SceneReset

This node resets the current RealFlow scene.

Inputs

NameTypesPassThroughDescription
inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

SceneSelectNode

This node selects the input 'nodes' of RealFlow scene.

Inputs

NameTypesPassThroughDescription
nodesRealFlow Nodethrough

The nodes

add to selectionBit (1) 

True to add the nodes to the current selection. False to create a new selection with them

Outputs

NameTypesPassThroughDescription
throughPassThroughnodes

The input 'nodes'

 

SceneUpdateInterface

This node forces an update of RealFlow user interface.

Inputs

NameTypesPassThroughDescription
updateBit (1) 

True to actually update the interface. False to act like a passthrough

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

SceneUpdateTimeLineCache

This node updates the time line of RealFlow - similar to selecting "Export->Update Time Line Cache".

Inputs

NameTypesPassThroughDescription
inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

SceneVariableResolve

This node returns a version of the input string with all its contained scene variables resolved.

A scene variable is a global string variable usually used for path composition with $(MACRONAME).

If the node input is '$(SCENEDIR)/particles' the output will look like '/user/scenes/my_scene/particles' .

Inputs

NameTypesPassThroughDescription
stringString
 Optional

result

The string that can contain scene variables like $(SCENEDIR)

Outputs

NameTypesPassThroughDescription
resultString
 Optional

string

The string with all the scene variables substituted by their values

 

SetCommandLineSimulationOptions

This node lets the user modify the scene command line simulation options.

Inputs

NameTypesPassThroughDescription
command line simulationBit (1) 

Perform simulation on Command Line

frame beginInteger (1) 

Frame begin

frame endInteger (1) 

Frame end

same range as sceneBit (1) 

Use current scene frame range

threadsInteger (1) 

Number of threads

same threads as sceneBit (1) 

Use current scene number of threads

resetBit (1) 

Reset command line flag

use cacheBit (1) 

Use Cache command line flag

meshBit (1) 

Mesh command line flag

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

 

SetCurrentFrame

This node changes the current frame of the RealFlow scene.

The output is the frame after the change.

Inputs

NameTypesPassThroughDescription
inInteger 

The new current current frame for the scene

Outputs

NameTypesPassThroughDescription
frameInteger 

The current frame of the scene after changing it

 

SetDyversoSimulationOptions

This node lets the user modify the scene Dyverso simulation options.

Inputs

NameTypesPassThroughDescription
time scaleReal (1) 

Time scale

stepping strictnessReal (1) 

Stepping strictness

max neighborsInteger (1) 

Max neighbors

dynamic search radiiBit (1) 

Dynamic search radii

use geometry velocityBit (1) 

Use geometry velocity

opencl cpuBit (1) 

Use OpenCL-CPU

opencl gpuBit (1) 

Use OpenCL-GPU

opencl gpu deviceInteger (1) 

OpenCL-GPU device ID

cuda gpuBit (1) 

Use CUDA-GPU

cuda gpu deviceInteger (1) 

CUDA-GPU device ID

liquid pbd min substepsInteger (1) 

Liquid PBD - minimum substeps

liquid pbd max substepsInteger (1) 

Liquid PBD - maximum substeps

liquid pbd min iterationsInteger (1) 

Liquid PBD - minimum iterations

liquid pbd max iterationsInteger (1) 

Liquid PBD - maximum iterations

liquid pbd accuracyReal (1) 

Liquid PBD - Accuracy

liquid sph min substepsInteger (1) 

Liquid SPH - minimum substeps

liquid sph max substepsInteger (1) 

Liquid SPH - maximum substeps

granular min substepsInteger (1) 

Granular - minimum substeps

granular max substepsInteger (1) 

Granular - maximum substeps

granular iterationsInteger (1) 

Granular - iterations

viscous min substepsInteger (1) 

Viscous - minimum substeps

viscous max substepsInteger (1) 

Viscous - maximum substeps

viscous iterationsInteger (1) 

Viscous - iterations

viscoelastic min substepsInteger (1) 

Viscoelastic - minimum substeps

viscoelastic max substepsInteger (1) 

Viscoelastic - maximum substeps

viscoelastic iterationsInteger (1) 

Viscoelastic - iterations

rigid min substepsInteger (1) 

Rigid - minimum substeps

rigid max substepsInteger (1) 

Rigid - maximum substeps

rigid iterationsInteger (1) 

Rigid - iterations

elastic min substepsInteger (1) 

Elastic - minimum substeps

elastic max substepsInteger (1) 

Elastic - maximum substeps

elastic iterationsInteger (1) 

Elastic - iterations

dumb min substepsInteger (1) 

Dumb - minimum substeps

dumb max substepsInteger (1) 

Dumb - maximum substeps

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

 

SetMaxFrames

This node changes the maximum frames in the RealFlow scene.

The output is the maximum number of frames after the change.

Inputs

NameTypesPassThroughDescription
inInteger 

The new maximum frames for the scene

Outputs

NameTypesPassThroughDescription
frame maxInteger 

The maximum frames of the scene after changing it

 

SetMaxwellIBLParameters

This node sets the Maxwell Render image-based lighting parameters.

Inputs

NameTypesPassThroughDescription
layer
 List

Background
Illumination
Reflection
Refraction

 

The layer

file path
 FilePath (1)

FilePath
String

 

The file path

intensityReal (1) 

The intensity

tile uReal (1) 

The tile u

tile vReal (1) 

The tile v

offset uReal (1) 

The offset u

offset vReal (1) 

The offset v

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

 

SetMaxwellParameters

This node sets the Maxwell Render parameters.

Inputs

NameTypesPassThroughDescription
intensityReal (1) 

Intensity. From 0 to 10

lightInteger (1) 

Light. From 0 to 99, being 0 the 5:00h, and 99 the 19:00h

sun rotationReal (1) 

Sun rotation in degrees. From 0 to 360

physical skyBit (1) 

Use physical sky

qualityInteger (1) 

Quality. From 20 to 100

no of threadsInteger (1) 

Number of threads. 0 for all

max frame timeInteger (1) 

Maximum frame render time. In seconds. This setting only affects the preview process

max sampling levelInteger (1) 

Maximum sampling level. This setting only affects the preview process

motion blurInteger (1) 

Motion blur factor. This setting only affects the preview process. From 0 to 30

global scaleReal (1) 

Global scale. From 0.001 to 100

production engineBit (1) 

Use draft engine. False to use the draft engine, true to use the production engine. This setting only affects the preview process

use iblBit (1) 

The use ibl

ibl illumination same as backgroundBit (1) 

The ibl illumination same as background

ibl reflection same as backgroundBit (1) 

The ibl reflection same as background

ibl refraction same as backgroundBit (1) 

The ibl refraction same as background

export alpha channelBit (1) 

The export alpha channel

export motion channelBit (1) 

The export motion channel

export normals channelBit (1) 

The export normals channel

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

 

SetSceneExportResourceValue

This node changes the information related to an export resource of the scene. Take note, the export resource must betyped with according brackets, e.g., 'Animation (.sd)'.

Inputs

NameTypesPassThroughDescription
resource idIntegerout resource id

The id of the resource to check

enableBit 

True to enable the export resource

nameString 

The name of the exported resource. You may get all available resources for a specific node by applying the 'GetAllNodeExportResources'-Node

pathString 

The path of the exported resource

optionString 

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

Outputs

NameTypesPassThroughDescription
out resource idPassThroughresource id

The out resource id

 

SetSceneVariable

This node sets the scene variable value stored in RealFlow.

If the name did not already exist it is created.A scene variable is a global string variable usually used for path composition with $(MACRONAME). Examples of scene variable names are SCENEDIR or IDOC.

The following scene variables should not be changed because they are reserved by RealFlow:

idoc, imagespath, kk, maxwellscenedir, maxwellscenename, objectspath, previewdir, rfdocfolder, rfdocpath, scenedir, videopreviewdir, videopreviewframesdir, videopreviewframesname, videopreviewname.

Inputs

NameTypesPassThroughDescription
nameStringout name

The name of the scene variable

valueString 

The new value for the variable

Outputs

NameTypesPassThroughDescription
out namePassThroughname

A passthrough of the input 'name'

 

SetSimulationOptions

This node returns the simulation parameters of the scene.

Inputs

NameTypesPassThroughDescription
fpsInteger (1) 

Frames per Second

no of threadsInteger (1) 

Number of threads. 0 for all

use max threadsBit (1) 

Use max. threads

master min substepsInteger (1) 

Master MIN substeps

master max substepsInteger (1) 

Master MAX substeps

hybrido time scaleInteger (1) 

Hybrido Time Scale

hybrido min substepsInteger (1) 

Hybrido MIN substeps

hybrido max substepsInteger (1) 

Hybrido MAX substeps

hybrido strictnessReal (1) 

Hybrido Strictness

pressure max iterationsInteger (1) 

Pressure Solver MAX iterations

pressure accuracyReal (1) 

Pressure Solver Accuracy

hybr 2nd solver min substInteger (1) 

Hybrido Secondary Solver - Stepping - MIN substeps

hybr 2nd solver max substInteger (1) 

Hybrido Secondary Solver - Stepping - MAX substeps

transport particle stepsInteger (1) 

Transport Particle Steps

hybrido collision face areaBit (1) 

Face area Hybrido collision fractions computation mode

hybrido collision supersamplingBit (1) 

Supersampling Hybrido collision fractions computation mode

hybrido collision samplesInteger (1) 

Supersampling Hybrido collision fractions computation mode number of samples

use opencl-cpuBit (1) 

Use OpenCL-CPU

use opencl-gpuBit (1) 

Use OpenCL-GPU

use opencl-accBit (1) 

Use OpenCL-ACC

caronte qualityInteger (1) 

Caronte Quality

caronte anti-jitterInteger (1) 

Caronte Anti-Jitter

caronte properties overrideBit (1) 

Characteristic object properties - Override

caronte properties thickness
 Numeric (1)

Integer
Integer64
Real
Vector3
Color4
ColorGradient
Quaternion
Matrix4

 

The caronte properties thickness

caronte properties lengthReal (1) 

Characteristic object properties - Length

caronte properties thickness01Real (1) 

Characteristic object properties - Thickness

geometry scaleReal (1) 

The geometry scale

cell size scaleReal (1) 

The cell size scale

daemon force scale for fluidsReal (1) 

The daemon force scale for fluids

daemon force scale for objectsReal (1) 

The daemon force scale for objects

reset to initial stateBit (1) 

Reset to Initial State flag

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

 

Simulate

This node starts the simulation of the current RealFlow scene.

Graph execution is aborted if scene is already simulating.

Inputs

NameTypesPassThroughDescription
inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

SimulateRange

This node starts the simulation of the current RealFlow scene from the 'start' frame to the 'stop' frame.

Graph execution is aborted if scene is already simulating.

Inputs

NameTypesPassThroughDescription
startInteger (1) 

The start

stopInteger (1) 

The stop

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'

 

SimulateStep

This node performs a simulation step. 'status' value is set to SIM_STATUS_FRAME_IS_UP(0) if we are in a new frame after the cycle; SIM_STATUS_FINISHED(1) if we reach the scene last frame after the cycle; SIM_STATUS_NORMAL(2) when nothing happened.

Inputs

NameTypesPassThroughDescription
inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
statusInteger 

The status

throughPassThroughin

The input 'in'

 

SimulationStop

This node stops the current RealFlow simulation, if the input 'condition' is 'true'.

If currently no simulation is in progress, the graph excecution is stopped.

Inputs

NameTypesPassThroughDescription
stopBit 

The stop

inPassThroughthrough

The in

Outputs

NameTypesPassThroughDescription
throughPassThroughin

The input 'in'