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

Name	Description
ExportCurrentFrame	This node exports ALL the enabled resources on the Export Central the same way they would do during a simulation.
GetAllSceneExportResourceOptions	This node returns all the export resource options allowed for the input 'resource id'.
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.
GetAllSceneVariableNames	This node returns all the scene variable names stored in RealFlow.
GetCurrentFrameTime	This node returns the time and frame according to the current status of the RealFlow scene.
GetFrameRange	This node returns the frame settings according to the current status of the RealFlow scene.
GetMaxwellIBLParameters	This node returns the Maxwell Render image-based lighting parameters.
GetMaxwellParameters	This node returns the Maxwell Render parameters.
GetPreferencesAxis	This node returns the actual used axis-system, which can be set in the File->Preferences menu.
GetSceneExportResourceIdFromDescription	This node returns all the information related to an export resource of the scene.
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.
GetSceneVariable	This node returns the scene variable value stored in RealFlow.
GetSimulationOptions	This node returns the simulation parameters of the scene.
MaxwellRenderRestart	This node forces a full restart of Maxwell Render interactive preview if it is running.
MaxwellRenderStop	This node stops Maxwell Render interactive preview if it is running.
ObjectSetMesh	This node replaces an existing object mesh with the input one.
SceneAddCamera	This node adds a new Camera to the scene.
SceneAddDaemon	This node adds a new daemon of the specified type to the scene.
SceneAddDefaultHubLink	This node creates a direct link between the given scene node and the default hub.
SceneAddDyversoDomain	This node adds a new DyversoDomain to the scene.
SceneAddDyversoEmitter	This node adds a new DyversoEmitter to the scene.
SceneAddHub	This node creates a new link hub.
SceneAddHubLink	This node creates a direct link between the given node and hub names.
SceneAddHybridoBubbles	This node adds a new HybridoBubbles to the scene.
SceneAddHybridoDomain	This node adds a new HybridoDomain to the scene.
SceneAddHybridoEmitter	This node adds a new HybridoEmitter to the scene.
SceneAddHybridoFoam	This node adds a new HybridoFoam to the scene.
SceneAddHybridoMesh	This node adds a new HybridoMesh to the scene.
SceneAddHybridoMist	This node adds a new HybridoMist to the scene.
SceneAddHybridoSplash	This node adds a new HybridoSplash to the scene.
SceneAddHybridoSplashAndFoam	This node adds a new HybridoSplashAndFoam to the scene.
SceneAddHybridoWaterLine	This node adds a new HybridoWaterLine to the scene.
SceneAddHybridoWet	This node adds a new HybridoWet to the scene.
SceneAddHybridoWetAndFoam	This node adds a new HybridoWetAndFoam to the scene.
SceneAddIdoc	This node adds a new Idoc to the scene.
SceneAddLink	This node creates a direct link between the given node or hub names.
SceneAddMultiBody	This node imports the input 'file path' as a MultiBody node and adds it to the RealFlow scene.
SceneAddMultiBodyFromMesh	This node adds a new multi body containing the input meshes.
SceneAddMultiJoint	This node adds a new MultiJoint to the scene.
SceneAddMultiServoPosAngular	This node adds a new MultiServoPosAngular to the scene.
SceneAddMultiServoPosLinear	This node adds a new MultiServoPosLinear to the scene.
SceneAddMultiServoVelAngular	This node adds a new MultiServoVelAngular to the scene.
SceneAddMultiServoVelLinear	This node adds a new MultiServoVelLinear to the scene.
SceneAddObject	This node adds a new object of the specified type to the scene.
SceneAddObjectFromMesh	This node adds a new object from the input mesh.
SceneAddParticleLegacyMesh	This node adds a new ParticleLegacyMesh to the scene.
SceneAddParticleMesh	This node adds a new ParticleMesh to the scene.
SceneAddRealFlowGroup	This node adds a new RealFlowGroup to the scene.
SceneAddStandardEmitter	This node adds a new RealFlow Standard Emitter to the scene. The concrete type is specified by the input.
SceneDefaultHubName	This node returns the name of the default hub of the scene.
SceneExistsHub	This node checks if there is a hub link with the requested name in the scene.
SceneExistsLink	This node checks if there is a link between 'source' and 'target'.
SceneGetAllHubs	This node returns the name of all the hubs in the scene.
SceneGetHubLinks	This node returns all the links with the input hub.
SceneGetNodeLinks	This node returns the links with the input node or hub.
SceneImageCurrentViewport	This node creates a screenshot of the current RealFlow active viewport.
SceneImportObjects	This node imports objects from the input 'file path' and adds them to the RealFlow scene.
SceneInterfaceEnableUpdates	This node enables or disables RealFlow user interface updates.
SceneInterfaceIsUpdatesEnabled	This node checks if RealFlow user interface updates are enabled.
SceneIsLinkAllowed	This node checks if the direct link between 'source' and 'target' is allowed.
SceneMaxwellRenderToImage	This node renders the current state of the scene from the input camera point of view.
SceneNew	This node creates a new scene, prompting the user to remove the current changes.
ScenePaint	This node enables again viewport painting and forces a repaint of RealFlow OpenGL viewport.
ScenePaintEnable	This node enables or disables RealFlow OpenGL viewport updates.
SceneRemoveHub	This node removes an existing hub.
SceneRemoveLink	This node removes an existing direct link between the given node or hub names.
SceneRemoveNode	This node removes any node from the scene.
SceneRenameHub	This node renames an existing hub.
SceneReset	This node resets the current RealFlow scene.
SceneSelectNode	This node selects the input 'nodes' of RealFlow scene.
SceneUpdateInterface	This node forces an update of RealFlow user interface.
SceneUpdateTimeLineCache	This node updates the time line of RealFlow - similar to selecting "Export->Update Time Line Cache".
SceneVariableResolve	This node returns a version of the input string with all its contained scene variables resolved.
SetCurrentFrame	This node changes the current frame of the RealFlow scene.
SetMaxFrames	This node changes the maximum frames in the RealFlow scene.
SetMaxwellIBLParameters	This node sets the Maxwell Render image-based lighting parameters.
SetMaxwellParameters	This node sets the Maxwell Render parameters.
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)'.
SetSceneVariable	This node sets the scene variable value stored in RealFlow.
SetSimulationOptions	This node returns the simulation parameters of the scene.
Simulate	This node starts the simulation of the current RealFlow scene.
SimulateRange	This node starts the simulation of the current RealFlow scene from the 'start' frame to the 'stop' frame.
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.
SimulationStop	This 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

Name	Types	PassThrough	Description
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	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

Name	Types	PassThrough	Description
resource id	Integer (1)		The id of the scene export resource

Outputs

Name	Types	PassThrough	Description
options	String		The options allowed by the input export resource
current value	String		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

Name	Types	PassThrough	Description
resource id	Integer		The id of the export resource
description	String		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

Name	Types	PassThrough	Description
names	String		The names of the scene variables currently stored in RealFlow

GetCurrentFrameTime

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

Outputs

Name	Types	PassThrough	Description
time	Real		The current time value of the scene
frame	Integer		The current frame of the scene

GetFrameRange

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

Outputs

Name	Types	Description
frame current	Integer	The current frame
frame last	Integer	The last frame of the scene
frame begin	Integer	The first frame of the current animation
frame end	Integer	The last frame of the current animation

GetMaxwellIBLParameters

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

Inputs

Name	Types	PassThrough	Description
layer	List Background Illumination Reflection Refraction		The layer

Outputs

Name	Types	Description
file path	FilePath FilePath String	The file path
intensity	Real	The intensity
tile u	Real	The tile u
tile v	Real	The tile v
offset u	Real	The offset u
offset v	Real	The offset v

GetMaxwellParameters

This node returns the Maxwell Render parameters.

Outputs

Name	Types	Description
intensity	Real	Intensity
light	Integer	Light. From 0 to 99, being 0 the 5:00h, and 99 the 19:00h
sun rotation	Real	Sun rotation in degrees, from 0 to 360
physical sky	Bit	Use physical sky
quality	Integer	Quality
no of threads	Integer	Number of threads
max frame time	Integer	Maximum frame render time. In seconds. This setting only affects the preview process
max sampling level	Integer	Maximum sampling level. This setting only affects the preview process
motion blur	Integer	Motion blur factor. This setting only affects the preview process
global scale	Real	Global scale
production engine	Bit	Use draft engine. False to use the draft engine, true to use the production engine. This setting only affects the preview process
use ibl	Bit	The use ibl
ibl illumination same as background	Bit	The ibl illumination same as background
ibl reflection same as background	Bit	The ibl reflection same as background
ibl refraction same as background	Bit	The ibl refraction same as background
export alpha channel	Bit	The export alpha channel
export motion channel	Bit	The export motion channel
export normals channel	Bit	The export normals channel

GetPreferencesAxis

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

Outputs

Name

Types

PassThrough

Description

axis id for reorder

Integer

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 id

Integer

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

Name	Types	PassThrough	Description
description	String		The description of the export resource to get the id from. It is not case-sensitive

Outputs

Name	Types	PassThrough	Description
resource id	Integer		The id of the export resource from the input 'node' that matches the input 'description'. -1 otherwise

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

Name	Types	PassThrough	Description
resource id	Integer		The id of the resource to check

Outputs

Name	Types	Description
exists	Bit	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
active	Bit	True if the resource export is enabled
name	String	The name of the exported resource
path	String	The path of the exported resource
description	String	The description of the exported resource
extension	String	The file extension used by the exported resource
has options	Bit	True if the exported resource has extra options. An example of resource options is the image format
option	String	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

Name	Types	PassThrough	Description
name	String		The name of the scene variable

Outputs

Name	Types	PassThrough	Description
value	String		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

Name	Types	Description
fps	Integer	Frames per Second
no of threads	Integer	Number of Threads
use max threads	Bit	Use max. threads
master min substeps	Integer	Master MIN substeps
master max substeps	Integer	Master MAX substeps
hybrido time scale	Integer	Hybrido Time Scale
hybrido min substeps	Integer	Hybrido MIN substeps
hybrido max substeps	Integer	Hybrido MAX substeps
hybrido strictness	Real	Hybrido Strictness
pressure max iterations	Integer	Pressure Solver MAX iterations
pressure accuracy	Real	Pressure Solver Accuracy
viscosity max iterations	Integer	Viscosity Solver MAX iterations
viscosity accuracy	Real	Viscosity Solver Accuracy
hybr 2nd solver min subst	Integer	Hybrido Secondary Solver - Stepping - MIN substeps
hybr 2nd solver max subst	Integer	Hybrido Secondary Solver - Stepping - MAX substeps
transport particle steps	Integer	Transport Particle Steps
use opencl-cpu	Bit	Use OpenCL-CPU
use opencl-gpu	Bit	Use OpenCL-GPU
use opencl-acc	Bit	Use OpenCL-ACC
caronte quality	Integer	Caronte Quality
caronte anti-jitter	Integer	Caronte Anti-Jitter
caronte properties override	Bit	Characteristic object properties - Override
caronte properties thickness	Real	Characteristic object properties - Thickness
caronte properties length	Real	Characteristic object properties - Length
geometry scale	Real	The geometry scale
cell size scale	Real	The cell size scale
daemon force scale for fluids	Real	The daemon force scale for fluids
daemon force scale for objects	Real	The daemon force scale for objects

MaxwellRenderRestart

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

Inputs

Name	Types	PassThrough	Description
restart	Bit (1)		True to actually restart the render. False to act like a passthrough
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	The input 'in'

MaxwellRenderStop

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

Inputs

Name	Types	PassThrough	Description
stop	Bit (1)		True to actually stop the render. False to act like a passthrough
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	The input 'in'

ObjectSetMesh

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

Inputs

Name	Types	PassThrough	Description
object	Object Object RealFlowNode	out object	The object
mesh	Mesh		The mesh

Outputs

Name	Types	PassThrough	Description
out object	PassThrough	object	The out object

SceneAddCamera

This node adds a new Camera to the scene.

Outputs

Name	Types	PassThrough	Description
camera	Camera Camera RealFlowNode		The new Camera

SceneAddDaemon

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

Inputs

Name	Types	PassThrough	Description
type	List		The type

Outputs

Name	Types	PassThrough	Description
daemon	Daemon Daemon RealFlowNode		The daemon

SceneAddDefaultHubLink

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

Name	Types	PassThrough	Description
node name	String		Name of node to add to the default hub
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
ok	Bit		True if the link was created. False otherwise
through	PassThrough	in	The input 'in'

SceneAddDyversoDomain

This node adds a new DyversoDomain to the scene.

Outputs

Name	Types	PassThrough	Description
dyverso domain	DyversoDomain DyversoDomain RealFlowNode		The new DyversoDomain

SceneAddDyversoEmitter

This node adds a new DyversoEmitter to the scene.

Outputs

Name	Types	PassThrough	Description
dyverso emitter	DyversoEmitter DyversoEmitter RealFlowNode		The new DyversoEmitter

SceneAddHub

This node creates a new link hub.

Inputs

Name	Types	PassThrough	Description
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
hub	String		The name of the created hub
through	PassThrough	in	The input 'in'

SceneAddHubLink

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

If the link already exists the return value is false.

Inputs

Name	Types	PassThrough	Description
node name	String		Name of node to add to the hub
hub	String		Name of hub to create the link with
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
ok	Bit		True if the link was created. False otherwise
through	PassThrough	in	The input 'in'

SceneAddHybridoBubbles

This node adds a new HybridoBubbles to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido bubbles	HybridoBubbles HybridoBubbles RealFlowNode		The new HybridoBubbles

SceneAddHybridoDomain

This node adds a new HybridoDomain to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido domain	HybridoDomain HybridoDomain RealFlowNode		The new HybridoDomain

SceneAddHybridoEmitter

This node adds a new HybridoEmitter to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido emitter	HybridoEmitter HybridoEmitter RealFlowNode		The new HybridoEmitter

SceneAddHybridoFoam

This node adds a new HybridoFoam to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido foam	HybridoFoam HybridoFoam RealFlowNode		The new HybridoFoam

SceneAddHybridoMesh

This node adds a new HybridoMesh to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido mesh	HybridoMesh HybridoMesh RealFlowNode		The new HybridoMesh

SceneAddHybridoMist

This node adds a new HybridoMist to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido mist	HybridoMist HybridoMist RealFlowNode		The new HybridoMist

SceneAddHybridoSplash

This node adds a new HybridoSplash to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido splash	HybridoSplash HybridoSplash RealFlowNode		The new HybridoSplash

SceneAddHybridoSplashAndFoam

This node adds a new HybridoSplashAndFoam to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido splash and foam	HybridoSplashAndFoam HybridoSplashAndFoam RealFlowNode		The new HybridoSplashAndFoam

SceneAddHybridoWaterLine

This node adds a new HybridoWaterLine to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido waterline	HybridoWaterLine HybridoWaterLine RealFlowNode		The new HybridoWaterLine

SceneAddHybridoWet

This node adds a new HybridoWet to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido wet	HybridoWet HybridoWet RealFlowNode		The new HybridoWet

SceneAddHybridoWetAndFoam

This node adds a new HybridoWetAndFoam to the scene.

Outputs

Name	Types	PassThrough	Description
hybrido wet and foam	HybridoWetAndFoam HybridoWetAndFoam RealFlowNode		The new HybridoWetAndFoam

SceneAddIdoc

This node adds a new Idoc to the scene.

Outputs

Name	Types	PassThrough	Description
idoc	Idoc IDOC RealFlowNode		The new Idoc

SceneAddLink

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

If the link already exists the return value is false.

Inputs

Name	Types	PassThrough	Description
source	String		Name of node or hub to be the source of the link
target	String		Name of node or hub to be the target of the link
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
ok	Bit		True if the link was created. False otherwise
through	PassThrough	in	The input 'in'

SceneAddMultiBody

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

Inputs

Name	Types	PassThrough	Description
file path	FilePath FilePath String		The file path

Outputs

Name	Types	PassThrough	Description
multibody	MultiBody MultiBody RealFlowNode		The multibody

SceneAddMultiBodyFromMesh

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

Inputs

Name	Types	PassThrough	Description
mesh	Mesh		The mesh

Outputs

Name	Types	PassThrough	Description
node	MultiBody MultiBody RealFlowNode		The node

SceneAddMultiJoint

This node adds a new MultiJoint to the scene.

Outputs

Name	Types	PassThrough	Description
multi joint	MultiJoint MultiJoint RealFlowNode		The new MultiJoint

SceneAddMultiServoPosAngular

This node adds a new MultiServoPosAngular to the scene.

Outputs

Name	Types	PassThrough	Description
multi servo pos angular	MultiServoPosAngular MultiServoPosAngular RealFlowNode		The new MultiServoPosAngular

SceneAddMultiServoPosLinear

This node adds a new MultiServoPosLinear to the scene.

Outputs

Name	Types	PassThrough	Description
multi servo pos linear	MultiServoPosLinear MultiServoPosLinear RealFlowNode		The new MultiServoPosLinear

SceneAddMultiServoVelAngular

This node adds a new MultiServoVelAngular to the scene.

Outputs

Name	Types	PassThrough	Description
multi servo vel angular	MultiServoVelAngular MultiServoVelAngular RealFlowNode		The new MultiServoVelAngular

SceneAddMultiServoVelLinear

This node adds a new MultiServoVelLinear to the scene.

Outputs

Name	Types	PassThrough	Description
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

Name	Types	PassThrough	Description
type	List null sphere hemisphere cube cube top open cylinder vase cone plane torus rocket capsule cross		The type

Outputs

Name	Types	PassThrough	Description
object	Object Object RealFlowNode		The object

SceneAddObjectFromMesh

This node adds a new object from the input mesh.

Inputs

Name	Types	PassThrough	Description
mesh	Mesh		The mesh

Outputs

Name	Types	PassThrough	Description
object	Object Object RealFlowNode		The object

SceneAddParticleLegacyMesh

This node adds a new ParticleLegacyMesh to the scene.

Outputs

Name	Types	PassThrough	Description
legacy mesh	ParticleLegacyMesh ParticleLegacyMesh RealFlowNode		The new ParticleLegacyMesh

SceneAddParticleMesh

This node adds a new ParticleMesh to the scene.

Outputs

Name	Types	PassThrough	Description
particle mesh	ParticleMesh ParticleMesh RealFlowNode		The new ParticleMesh

SceneAddRealFlowGroup

This node adds a new RealFlowGroup to the scene.

Outputs

Name	Types	PassThrough	Description
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

Name	Types	PassThrough	Description
type	List		The type

Outputs

Name	Types	PassThrough	Description
emitter	StandardEmitter StandardEmitter RealFlowNode		The emitter

SceneDefaultHubName

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

Outputs

Name	Types	PassThrough	Description
hub	String		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

Name	Types	PassThrough	Description
hub	String		Name of hub to check
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
result	Bit		True if the hub exists. False otherwise
through	PassThrough	in	The input 'in'

SceneExistsLink

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

Inputs

Name	Types	PassThrough	Description
source	String		Name of node or hub to be the source of the link
target	String		Name of node or hub to be the target of the link
check implicit	Bit		True to check also implicit links. False for checking only direct links
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
result	Bit		True if the link exists. False otherwise
through	PassThrough	in	The input 'in'

SceneGetAllHubs

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

Outputs

Name	Types	PassThrough	Description
hubs	String		The name of the hubs in the scene

SceneGetHubLinks

This node returns all the links with the input hub.

Inputs

Name	Types	PassThrough	Description
hub	String		The hub to check the links with

Outputs

Name	Types	PassThrough	Description
links	String		The name of the links to the input hub

SceneGetNodeLinks

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

Inputs

Name	Types	Description
node	String	Name of node or hub to check the links
is source	Bit	True to include links where the node is the source
is target	Bit	True to include links where the node is the target
check implicit	Bit	True to include implicit links with the given node. False to include only direct links

Outputs

Name	Types	PassThrough	Description
links	String		Nodes linked with the input node

SceneImageCurrentViewport

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

Inputs

Name	Types	PassThrough	Description
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
image	Image		An image containing the current render of the active viewport
through	PassThrough	in	The input 'in'

SceneImportObjects

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

Inputs

Name	Types	PassThrough	Description
file path	FilePath (1) FilePath String		The file path

Outputs

Name	Types	PassThrough	Description
objects	Object Object RealFlowNode		The objects

SceneInterfaceEnableUpdates

This node enables or disables RealFlow user interface updates.

Inputs

Name	Types	PassThrough	Description
enable	Bit (1)		True to enable interface updates. False to disable them
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	The input 'in'

SceneInterfaceIsUpdatesEnabled

This node checks if RealFlow user interface updates are enabled.

Inputs

Name	Types	PassThrough	Description
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
enabled	Bit		True if interface updates are enabled. False otherwise
through	PassThrough	in	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

Name	Types	PassThrough	Description
source	String		Name of node or hub to be the source of the link
target	String		Name of node or hub to be the target of the link
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
result	Bit		True if the link is allowed. False otherwise
through	PassThrough	in	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

Name	Types	PassThrough	Description
camera	Camera Camera RealFlowNode		The camera to use for the render. If none is connected, render is performed using the selected view
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
image	Image		An image containing a Maxwell Render of the current frame
through	PassThrough	in	The input 'in'

SceneNew

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

Outputs

Name	Types	PassThrough	Description
cleaned	Bit		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

Name	Types	PassThrough	Description
paint	Bit (1)		True to repaint the viewport. False to act like a passthrough
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	The input 'in'

ScenePaintEnable

This node enables or disables RealFlow OpenGL viewport updates.

Inputs

Name	Types	PassThrough	Description
enable	Bit (1)		True to enable OpenGL viewport painting. False to disable it
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	The input 'in'

SceneRemoveHub

This node removes an existing hub.

Inputs

Name	Types	PassThrough	Description
hub	String		Name of hub to remove
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
ok	Bit		True if the hub was removed. False otherwise
through	PassThrough	in	The input 'in'

SceneRemoveLink

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

Name	Types	PassThrough	Description
source	String		Name of node or hub to be the source of the removed link
target	String		Name of node or hub to be the target of the removed link
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
ok	Bit		True if the link was removed. False otherwise
through	PassThrough	in	The input 'in'

SceneRemoveNode

This node removes any node from the scene.

Inputs

Name	Types	PassThrough	Description
node	RealFlow Node		The node

Outputs

Name	Types	PassThrough	Description
evaluate	Evaluate		The evaluate

SceneRenameHub

This node renames an existing hub.

Inputs

Name	Types	PassThrough	Description
hub	String		Name of hub to rename
new hub name	String		New name for the hub
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
ok	Bit		True if the hub was renamed. False otherwise
through	PassThrough	in	The input 'in'

SceneReset

This node resets the current RealFlow scene.

Inputs

Name	Types	PassThrough	Description
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	The input 'in'

SceneSelectNode

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

Inputs

Name	Types	PassThrough	Description
nodes	RealFlow Node	through	The nodes
add to selection	Bit (1)		True to add the nodes to the current selection. False to create a new selection with them

Outputs

Name	Types	PassThrough	Description
through	PassThrough	nodes	The input 'nodes'

SceneUpdateInterface

This node forces an update of RealFlow user interface.

Inputs

Name	Types	PassThrough	Description
update	Bit (1)		True to actually update the interface. False to act like a passthrough
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	The input 'in'

SceneUpdateTimeLineCache

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

Inputs

Name	Types	PassThrough	Description
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	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

Name	Types	PassThrough	Description
string	String	Optional result	The string that can contain scene variables like $(SCENEDIR)

Outputs

Name	Types	PassThrough	Description
result	String	Optional string	The string with all the scene variables substituted by their values

SetCurrentFrame

This node changes the current frame of the RealFlow scene.

The output is the frame after the change.

Inputs

Name	Types	PassThrough	Description
in	Integer		The new current current frame for the scene

Outputs

Name	Types	PassThrough	Description
frame	Integer		The current frame of the scene after changing it

SetMaxFrames

This node changes the maximum frames in the RealFlow scene.

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

Inputs

Name	Types	PassThrough	Description
in	Integer		The new maximum frames for the scene

Outputs

Name	Types	PassThrough	Description
frame max	Integer		The maximum frames of the scene after changing it

SetMaxwellIBLParameters

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

Inputs

Name	Types	Description
layer	List Background Illumination Reflection Refraction	The layer
file path	FilePath (1) FilePath String	The file path
intensity	Real (1)	The intensity
tile u	Real (1)	The tile u
tile v	Real (1)	The tile v
offset u	Real (1)	The offset u
offset v	Real (1)	The offset v

Outputs

Name	Types	PassThrough	Description
evaluate	Evaluate		The evaluate

SetMaxwellParameters

This node sets the Maxwell Render parameters.

Inputs

Name	Types	Description
intensity	Real (1)	Intensity. From 0 to 10
light	Integer (1)	Light. From 0 to 99, being 0 the 5:00h, and 99 the 19:00h
sun rotation	Real (1)	Sun rotation in degrees. From 0 to 360
physical sky	Bit (1)	Use physical sky
quality	Integer (1)	Quality. From 20 to 100
no of threads	Integer (1)	Number of threads. 0 for all
max frame time	Integer (1)	Maximum frame render time. In seconds. This setting only affects the preview process
max sampling level	Integer (1)	Maximum sampling level. This setting only affects the preview process
motion blur	Integer (1)	Motion blur factor. This setting only affects the preview process. From 0 to 30
global scale	Real (1)	Global scale. From 0.001 to 100
production engine	Bit (1)	Use draft engine. False to use the draft engine, true to use the production engine. This setting only affects the preview process
use ibl	Bit (1)	The use ibl
ibl illumination same as background	Bit (1)	The ibl illumination same as background
ibl reflection same as background	Bit (1)	The ibl reflection same as background
ibl refraction same as background	Bit (1)	The ibl refraction same as background
export alpha channel	Bit (1)	The export alpha channel
export motion channel	Bit (1)	The export motion channel
export normals channel	Bit (1)	The export normals channel

Outputs

Name	Types	PassThrough	Description
evaluate	Evaluate		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

Name	Types	PassThrough	Description
resource id	Integer	out resource id	The id of the resource to check
enable	Bit		True to enable the export resource
name	String		The name of the exported resource. You may get all available resources for a specific node by applying the 'GetAllNodeExportResources'-Node
path	String		The path of the exported resource
option	String		The option to set for the exported resource. It is not case-sensitive

Outputs

Name	Types	PassThrough	Description
out resource id	PassThrough	resource 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

Name	Types	PassThrough	Description
name	String	out name	The name of the scene variable
value	String		The new value for the variable

Outputs

Name	Types	PassThrough	Description
out name	PassThrough	name	A passthrough of the input 'name'

SetSimulationOptions

This node returns the simulation parameters of the scene.

Inputs

Name	Types	Description
fps	Integer (1)	Frames per Second
no of threads	Integer (1)	Number of threads. 0 for all
use max threads	Bit (1)	Use max. threads
master min substeps	Integer (1)	Master MIN substeps
master max substeps	Integer (1)	Master MAX substeps
hybrido time scale	Integer (1)	Hybrido Time Scale
hybrido min substeps	Integer (1)	Hybrido MIN substeps
hybrido max substeps	Integer (1)	Hybrido MAX substeps
hybrido strictness	Real (1)	Hybrido Strictness
pressure max iterations	Integer (1)	Pressure Solver MAX iterations
pressure accuracy	Real (1)	Pressure Solver Accuracy
hybr 2nd solver min subst	Integer (1)	Hybrido Secondary Solver - Stepping - MIN substeps
hybr 2nd solver max subst	Integer (1)	Hybrido Secondary Solver - Stepping - MAX substeps
transport particle steps	Integer (1)	Transport Particle Steps
use opencl-cpu	Bit (1)	Use OpenCL-CPU
use opencl-gpu	Bit (1)	Use OpenCL-GPU
use opencl-acc	Bit (1)	Use OpenCL-ACC
caronte quality	Integer (1)	Caronte Quality
caronte anti-jitter	Integer (1)	Caronte Anti-Jitter
caronte properties override	Bit (1)	Characteristic object properties - Override
caronte properties thickness	Numeric (1) Integer Integer64 Real Vector3 Color4 ColorGradient Quaternion Matrix4	The caronte properties thickness
caronte properties length	Real (1)	Characteristic object properties - Length
caronte properties thickness01	Real (1)	Characteristic object properties - Thickness
geometry scale	Real (1)	The geometry scale
cell size scale	Real (1)	The cell size scale
daemon force scale for fluids	Real (1)	The daemon force scale for fluids
daemon force scale for objects	Real (1)	The daemon force scale for objects

Outputs

Name	Types	PassThrough	Description
evaluate	Evaluate		The evaluate

Simulate

This node starts the simulation of the current RealFlow scene.

Graph execution is aborted if scene is already simulating.

Inputs

Name	Types	PassThrough	Description
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	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

Name	Types	PassThrough	Description
start	Integer (1)		The start
stop	Integer (1)		The stop
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	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

Name	Types	PassThrough	Description
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
status	Integer		The status
through	PassThrough	in	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

Name	Types	PassThrough	Description
stop	Bit		The stop
in	PassThrough	through	The in

Outputs

Name	Types	PassThrough	Description
through	PassThrough	in	The input 'in'