Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

These nodes are a perfect addition to RealFlow's comprehensive import and export capabilities, because they provide much more flexibility. The nodes support:

  • Fields
  • Images
  • Meshes
  • Particles

Some nodes are also directly connected to RealFlow's "Export Central" dialogue and create an output according to the active export resource. You can also choose from a wide variety of file formats.

Nodes

NameDescription
Color4ReadFromFilePathThis node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.
FieldRealLoadThis node loads field/s data from a file. File formats supported so far are Field3D (.f3d) and OpenVDB (.vdb ).
FieldSaveThis node saves field data to a file.
FieldVector3LoadThis node loads field/s data from a file. File formats supported so far are Field3D (.f3d) and OpenVDB (.vdb ).
FilePathInfoThis node returns information about the input file path.
FolderInfoThis node returns information about the input folder.
ImageLoadThis node loads images from files.
ImageSaveThis node saves the input 'image' to file.
Integer64ReadFromFilePathThis node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.
IntegerReadFromFilePathThis node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.
Matrix4ReadFromFilePathThis node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.
MeshLoadThis node loads mesh channel data from a file. The file format is extracted from the file extension and valid file formats are Alembic (.abc), Wavefront (.obj) and RealFlow BIN (.bin).
MeshSaveThis node saves mesh channel data to a file.
NodeDataExportMakes the input 'node' to export its data according to its current Export Central settings.
NodeDataReloadMakes the input 'node' to reload its data according to its current Export Central settings.
NumWriteToFilePathThis node writes to the specified 'file path' a binary version of the input 'input'.
ParticleLoadThis node loads particle channel data from a file. The file format is extracted from the file extension and valid file formats are Alembic (.abc), RealFlow Particle Cache (.rpc) and RealFlow BIN (.bin).
ParticleSaveThis node saves particle channel data to a file.
QuaternionReadFromFilePathThis node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.
RealReadFromFilePathThis node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.
SceneLoadThis node loads the input scene, removing the changes of the current one.
SceneSaveThis node saves the current scene at the input 'file path'.
StringReadFromFilePathThis node reads from the input 'file path' as many bytes at most as the 'max bytes' input, starting from the file byte position specified by 'position', to the output 'string'.
StringWriteToFilePathThis node writes to the specified 'file path' the input 'string'.
Vector3ReadFromFilePathThis node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.

Color4ReadFromFilePath

This node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path to be read

start positionInteger64 (1) 

The position of the file in bytes to begin to read from

read sizeBit (1) 

True to consider the first 4 bytes as the number of elements contained in the file

max countInteger (1) 

The maximum number of elements of the type to be read. If negative, there is no limit

Outputs

NameTypesPassThroughDescription
read countInteger 

The total amount of elements read from the file

last positionInteger64 

The last position read from the file, in bytes

okBit 

True if the output was successfully read from the file. False otherwise

colorColor4 

The number read from the file

FieldRealLoad

This node loads field/s data from a file. File formats supported so far are Field3D (.f3d) and OpenVDB (.vdb ).

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The path for the file to load

nameString 

The names of the fields to load. They must be separated with "," ";" or blank space. An empty name means load all available fields

Outputs

NameTypesPassThroughDescription
fieldRealField 

The field

okBit 

True if the file was successfully loaded, False otherwise

FieldSave

This node saves field data to a file.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The path for the file to save

field
 FieldBase (1)

DistanceField
RealField
Vector3Field

 

The field

format
 List (1)

Field3D (.f3d)
OpenVDB (.vdb)

 

The file format

compression hint
 List (1)

No compression
1
2
3
4
5
6
7
8
9

 

The level of compression

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

okBit 

True if the file was successfully saved, False otherwise

FieldVector3Load

This node loads field/s data from a file. File formats supported so far are Field3D (.f3d) and OpenVDB (.vdb ).

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The path for the file to load

nameString 

The names of the fields to load. They must be separated with "," ";" or blank space. An empty name means load all available fields

Outputs

NameTypesPassThroughDescription
fieldVector3Field 

The field

okBit 

True if the file was successfully loaded, False otherwise

FilePathInfo

This node returns information about the input file path.

Inputs

NameTypesPassThroughDescription
file path
 FilePath

FilePath
Folder
String

 

The file path to check the info about

Outputs

NameTypesPassThroughDescription
existsBit 

True if the path exists

is folderBit 

True if the path points to a folder

is fileBit 

True if the path points to a file

is linkBit 

True if the path points to a symbolic link

is relativeBit 

True if the path is relative

is readableBit 

True if the path allows reading

is writableBit 

True if the path allows writing

is executableBit 

True if the path can be executed

contains macrosBit 

True if the path is composed by a macro like $(SCENEDIR)

bytesInteger64 

The size of the input file path in bytes. If it is a folder it does not compute the size of its content

creation secondsInteger64 

The date of creation of the input file path in seconds from epoc

modification secondsInteger64 

The date of the last modification of the input file path in seconds from epoc

parent folderString 

The absolute path to the parent folder of the input path

file nameString 

The name of the input file, containing the extension

base nameString 

The name of the input file without the extension

extensionString 

The extension of the input file

absolute pathString 

The absolute path that points to the input file path

FolderInfo

This node returns information about the input folder.

Inputs

NameTypesPassThroughDescription
folder
 Folder (1)

Folder
String

 

The folder to check the info about

Outputs

NameTypesPassThroughDescription
existsBit 

True if the folder exists

is linkBit 

True if the folder path points to a symbolic link

is readableBit 

True if the folder allows reading

is writableBit 

True if the path allows writing

is executableBit 

True if the folder can be executed (opened)

total bytesInteger64 

The size of the input folder content recursively.

Keep in mind that computing the whole content of a folder can be an expensive operation

available bytesInteger64 

The current available space in bytes for this folder.

 

creation secondsInteger64 

The date of creation of the input folder in seconds from epoc

modification secondsInteger64 

The date of the last modification of the input folder in seconds from epoc

parent folderString 

The absolute path to the parent folder of the input folder

base nameString 

The name of the input folder without the parent folder path

absolute pathString 

The absolute path that points to the input folder

folder filesString 

The list of all the file names contained inside this folder at top level

folder treeString 

The list of all the file absolute paths contained inside this folder recursively. This operation can be expensive depending on the size and location of the folder

ImageLoad

This node loads images from files.

Loaded image pixel 0,0 refers to the bottom left pixel of the image.

Inputs

NameTypesPassThroughDescription
file path
 FilePath

FilePath
String

 

The file path

Outputs

NameTypesPassThroughDescription
imageImage 

The image

ImageSave

This node saves the input 'image' to file.

File format is deduced from the input 'file path' extension.

Inputs

NameTypesPassThroughDescription
file path
 FilePath

FilePath
String

 

The file path

imageImagethrough

The image

Outputs

NameTypesPassThroughDescription
throughPassThroughimage

The input 'image'

Integer64ReadFromFilePath

This node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path to be read

start positionInteger64 (1) 

The position of the file in bytes to begin to read from

read sizeBit (1) 

True to consider the first 4 bytes as the number of elements contained in the file

max countInteger (1) 

The maximum number of elements of the type to be read. If negative, there is no limit

Outputs

NameTypesPassThroughDescription
read countInteger 

The total amount of elements read from the file

last positionInteger64 

The last position read from the file, in bytes

okBit 

True if the output was successfully read from the file. False otherwise

integer64Integer64 

The number read from the file

IntegerReadFromFilePath

This node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path to be read

start positionInteger64 (1) 

The position of the file in bytes to begin to read from

read sizeBit (1) 

True to consider the first 4 bytes as the number of elements contained in the file

max countInteger (1) 

The maximum number of elements of the type to be read. If negative, there is no limit

Outputs

NameTypesPassThroughDescription
read countInteger 

The total amount of elements read from the file

last positionInteger64 

The last position read from the file, in bytes

okBit 

True if the output was successfully read from the file. False otherwise

integerInteger 

The number read from the file

Matrix4ReadFromFilePath

This node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path to be read

start positionInteger64 (1) 

The position of the file in bytes to begin to read from

read sizeBit (1) 

True to consider the first 4 bytes as the number of elements contained in the file

max countInteger (1) 

The maximum number of elements of the type to be read. If negative, there is no limit

Outputs

NameTypesPassThroughDescription
read countInteger 

The total amount of elements read from the file

last positionInteger64 

The last position read from the file, in bytes

okBit 

True if the output was successfully read from the file. False otherwise

matrixMatrix4 

The number read from the file

MeshLoad

This node loads mesh channel data from a file. The file format is extracted from the file extension and valid file formats are Alembic (.abc), Wavefront (.obj) and RealFlow BIN (.bin).

The channel filter is a text string where an empty value must be used for loading all the channels. To load one or several channels the names must be separated with "," ";" or blank space.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The path for the file to load

channelString 

The names of the channels to load. They must be separated with "," ";" or blank space. An empty name means load all available channels

Outputs

NameTypesPassThroughDescription
meshMesh 

The mesh loaded from the file

okBit 

True if the file was successfully loaded, False otherwise

MeshSave

This node saves mesh channel data to a file.

The channel filter is a text string where an empty value must be used for saving all the channels. To save one or several channels the names must be separated with "," ";" or blank space.

Please notice that even though an array of mesh is accepted as input the BIN format only supports one mesh, so in this particular case only the first mesh of the array will be saved.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The path for the file to save

meshMesh 

The mesh

channelString (1) 

The names of the channels to save. They must be separated with "," ";" or blank space. An empty name means save all available channels

format
 List (1)

Wavefront (.obj)
Alembic (.abc)
RealFlow BIN (.bin)

 

The file format

compression hint
 List (1)

No compression
1
2
3
4
5
6
7
8
9

 

The level of compression. Please notice that the BIN and the OBJ file formats ignore this value

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

okBit 

True if the file was successfully saved, False otherwise

NodeDataExport

Makes the input 'node' to export its data according to its current Export Central settings.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Node 

The node or nodes

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

NodeDataReload

Makes the input 'node' to reload its data according to its current Export Central settings.

Inputs

NameTypesPassThroughDescription
nodeRealFlow Nodethrough

The node or nodes

Outputs

NameTypesPassThroughDescription
throughPassThroughnode

The input 'node'

NumWriteToFilePath

This node writes to the specified 'file path' a binary version of the input 'input'.

If 'write size' is enabled, it will first write a 32 bit integer with the number of elements of 'input'.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
input
 Numeric

Integer
Integer64
Real
Vector3
Color4
Quaternion
Matrix4

through

The numeric values to write to the file

file path
 FilePath (1)

FilePath
String

 

The file path were to write the binary file

appendBit (1) 

True to append the values to the end of the file if it previously exists.

False to overwrite the file if it already exists

write sizeBit (1) 

If true, it will write at the beginning a 32 bit integer with the number of elements of 'input'

Outputs

NameTypesPassThroughDescription
bytes writtenInteger64 

The total amount of bytes written to the file

okBit 

True if the input was successfully written to file. False otherwise

throughPassThroughinput

The input 'input'

ParticleLoad

This node loads particle channel data from a file. The file format is extracted from the file extension and valid file formats are Alembic (.abc), RealFlow Particle Cache (.rpc) and RealFlow BIN (.bin).

The channel filter is a text string where an empty value must be used for loading all the channels. To load one or several channels the names must be separated with "," ";" or blank space.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The path for the file to load

channelString 

The names of the channels to load. They must be separated with "," ";" or blank space. An empty name means load all available channels

Outputs

NameTypesPassThroughDescription
out particlesParticles 

The particles loaded from the file

okBit 

True if the file was successfully loaded, False otherwise

ParticleSave

This node saves particle channel data to a file.

The channel filter is a text string where an empty value must be used for saving all the channels. To save one or several channels the names must be separated with "," ";" or blank space.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The path for the file to save

particlesParticles 

The particles

channelString (1) 

The names of the channels to save. They must be separated with "," ";" or blank space. An empty name means save all available channels

format
 List (1)

RealFlow Particle Cache (.rpc)
Alembic (.abc)
RealFlow BIN (.bin)
Krakatoa Particle File (.prt)

 

The file format

compression hint
 List (1)

No compression
1
2
3
4
5
6
7
8
9

 

The level of compression. Please note that the BIN file format ignores this value

Outputs

NameTypesPassThroughDescription
evaluateEvaluate 

The evaluate

okBit 

True if the file was successfully saved, False otherwise

QuaternionReadFromFilePath

This node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path to be read

start positionInteger64 (1) 

The position of the file in bytes to begin to read from

read sizeBit (1) 

True to consider the first 4 bytes as the number of elements contained in the file

max countInteger (1) 

The maximum number of elements of the type to be read. If negative, there is no limit

Outputs

NameTypesPassThroughDescription
read countInteger 

The total amount of elements read from the file

last positionInteger64 

The last position read from the file, in bytes

okBit 

True if the output was successfully read from the file. False otherwise

quaternionQuaternion 

The number read from the file

RealReadFromFilePath

This node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path to be read

start positionInteger64 (1) 

The position of the file in bytes to begin to read from

read sizeBit (1) 

True to consider the first 4 bytes as the number of elements contained in the file

max countInteger (1) 

The maximum number of elements of the type to be read. If negative, there is no limit

Outputs

NameTypesPassThroughDescription
read countInteger 

The total amount of elements read from the file

last positionInteger64 

The last position read from the file, in bytes

okBit 

True if the output was successfully read from the file. False otherwise

realReal 

The number read from the file

SceneLoad

This node loads the input scene, removing the changes of the current one.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path of the scene to load

Outputs

NameTypesPassThroughDescription
loadedBit 

True if the scene was successfully loaded. False otherwise

SceneSave

This node saves the current scene at the input 'file path'.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path to save the scene to

Outputs

NameTypesPassThroughDescription
savedBit 

True if the scene was successfully saved. False otherwise

StringReadFromFilePath

This node reads from the input 'file path' as many bytes at most as the 'max bytes' input, starting from the file byte position specified by 'position', to the output 'string'.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path to be read

positionInteger64 (1) 

The position of the file in bytes to begin to read from

max bytesInteger64 (1) 

The maximum amount of bytes allowed to be read from the file. If negative, the whole file will be read

Outputs

NameTypesPassThroughDescription
bytes readInteger64 

The total amount of bytes read from the file

last positionInteger64 

The last position written in the file. In bytes

okBit 

True if the output 'string' was successfully read from the file. False otherwise

stringString 

The characters read from the file

StringWriteToFilePath

This node writes to the specified 'file path' the input 'string'.

If the input 'string' contains more than one strings, all of them are concatenated one after the other.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
stringStringthrough

The string to write to the file

file path
 FilePath (1)

FilePath
String

 

The file path were to write the string

appendBit (1) 

True to append the string to the end of the file if it previously exists.

False to overwrite the file if it already exists

Outputs

NameTypesPassThroughDescription
bytes writtenInteger64 

The total amount of bytes written to the file

okBit 

True if the input 'string' was successfully written to file. False otherwise

throughPassThroughstring

The input 'string'

Vector3ReadFromFilePath

This node reads from the input binary 'file path'. If 'read size' is true, the first 4 bytes from 'position' are read and used as the number of elements stored in the file. If 'max count' is not negative the number of elements read is the minimum between 'max count' and the size read. If size was not read, the number of elements is computed using the size of the file.

If the 'ok' output is connected, no error is shown. Otherwise, write errors will result in node errors.

Inputs

NameTypesPassThroughDescription
file path
 FilePath (1)

FilePath
String

 

The file path to be read

start positionInteger64 (1) 

The position of the file in bytes to begin to read from

read sizeBit (1) 

True to consider the first 4 bytes as the number of elements contained in the file

max countInteger (1) 

The maximum number of elements of the type to be read. If negative, there is no limit

Outputs

NameTypesPassThroughDescription
read countInteger 

The total amount of elements read from the file

last positionInteger64 

The last position read from the file, in bytes

okBit 

True if the output was successfully read from the file. False otherwise

vectorVector3 

The number read from the file

  • No labels