Fields

For working with and manipulating fields. Evaluating at specific indices, offsetting, fallback values and picking from groups.

Index Mixed

Offset the current point’s Index by a given amount, returning the fractional Index value

Inputs

Name	Type	Description	Default
Index	`Int`	The floor and ceiling of this Index value is taken and used for sampling, the fraction of this value is then used to mix between the sampled values	`Index`
Offset	`Float`		`0.5`

Outputs

Name	Type	Description	Default
Mixed	`Float`		`0.0`
Floor	`Int`	Index of the point being interpolated from	None
Ceiling	`Int`	Index of the point being interpolated to	None

Index Mix Float

Sample and interpolate the Float value between the floor and ceiling of the given Index, by the fractional amount

Inputs

Name	Type	Description	Default
Value	`Float`	The field to sample and interpolate between	`0.0`
Index	`Float`	The floor and ceiling of this Index value is taken and used for sampling, the fraction of this value is then used to mix between the sampled values	`0.0`

Outputs

Name	Type	Description	Default
Value	`Float`	Interpolated value, sampled from the floor and ceiling and mixed by the fraction of the the input value	`0.0`
Floor	`Int`	Index of the point being interpolated from	None
Ceiling	`Int`	Index of the point being interpolated to	None

Index Mix Vector

Sample and interpolate the Vector value between the floor and ceiling of the given Index, by the fractional amount

Inputs

Name	Type	Description	Default
Value	`Vector`	The field to sample and interpolate between	`[0.0, 0.0, 0.0]`
Index	`Float`	The floor and ceiling of this Index value is taken and used for sampling, the fraction of this value is then used to mix between the sampled values	`0.0`

Outputs

Name	Type	Description	Default
Value	`Vector`	Interpolated value, sampled from the floor and ceiling and mixed by the fraction of the the input value	`[0.0, 0.0, 0.0]`
Floor	`Int`	Index of the point being interpolated from	None
Ceiling	`Int`	Index of the point being interpolated to	None

Index Mix Rotation

Sample and interpolate the Rotation value between the floor and ceiling of the given Index, by the fractional amount

Inputs

Name	Type	Description	Default
Rotation	`Rotation`	The field to sample and interpolate between	`<Euler (x=0.0000, y=0.0000, z=0.0000), order='XYZ'>`
Index	`Float`	The floor and ceiling of this Index value is taken and used for sampling, the fraction of this value is then used to mix between the sampled values	`0.0`

Outputs

Name	Type	Description	Default
Rotation	`Rotation`	Interpolated value, sampled from the floor and ceiling and mixed by the fraction of the the input value	`<Euler (x=0.0000, y=0.0000, z=0.0000), order='XYZ'>`
Floor	`Int`	Index of the point being interpolated from	None
Ceiling	`Int`	Index of the point being interpolated to	None

Index Mix Color

Sample and interpolate the Color value between the floor and ceiling of the given Index, by the fractional amount

Inputs

Name	Type	Description	Default
Color	`Color`	The field to sample and interpolate between	`[1.0, 1.0, 1.0, 1.0]`
Index	`Float`	The floor and ceiling of this Index value is taken and used for sampling, the fraction of this value is then used to mix between the sampled values	`0.0`

Outputs

Name	Type	Description	Default
Color	`Color`	Interpolated value, sampled from the floor and ceiling and mixed by the fraction of the the input value	`[0.0, 0.0, 0.0, 1.0]`
Floor	`Int`	Index of the point being interpolated from	None
Ceiling	`Int`	Index of the point being interpolated to	None

Sample Position

Sample the Position attribute from a point at the given Index

Inputs

Name	Type	Description	Default
Geometry	`Geometry`		None
Index	`Int`		`Index`

Outputs

Name	Type	Description	Default
Position	`Vector`		`[0.0, 0.0, 0.0]`

Sample Mixed Float

Sample the Float attribute, mixed between the floor and ceiling of the given Index

Inputs

Name	Type	Default
Geometry	`Geometry`	None
Value	`Float`	`0.0`
Index	`Float`	`0.0`

Outputs

Name	Type	Description	Default
Value	`Float`		`0.0`

Sample Mixed Vector

Sample the Vector attribute, mixed between the floor and ceiling of the given Index

Inputs

Name	Type	Default
Geometry	`Geometry`	None
Value	`Vector`	`[0.0, 0.0, 0.0]`
Index	`Float`	`0.0`

Outputs

Name	Type	Description	Default
Value	`Vector`		`[0.0, 0.0, 0.0]`

Sample Mixed Rotation

Sample the Rotation attribute, mixed between the floor and ceiling of the given Index

Inputs

Name	Type	Default
Geometry	`Geometry`	None
Rotation	`Rotation`	`<Euler (x=0.0000, y=0.0000, z=0.0000), order='XYZ'>`
Index	`Float`	`0.0`

Outputs

Name	Type	Description	Default
Rotation	`Rotation`		`<Euler (x=0.0000, y=0.0000, z=0.0000), order='XYZ'>`

Sample Mixed Color

Sample the Color attribute, mixed between the floor and ceiling of the given Index

Inputs

Name	Type	Default
Geometry	`Geometry`	None
Color	`Color`	`[0.0, 0.0, 0.0, 1.0]`
Index	`Float`	`0.0`

Outputs

Name	Type	Description	Default
Color	`Color`		`[0.0, 0.0, 0.0, 1.0]`

Offset Integer

Evaluate an Integer at an index that is offset by the specified amount

Inputs

Name	Type	Default
Index	`Int`	`Index`
Value	`Int`	None
Offset	`Int`	None

Outputs

Name	Type	Description	Default
Value	`Int`		None

Offset Float

Evaluate a Float value at an index that is offset by the specified amount

Inputs

Name	Type	Default
Index	`Int`	`Index`
Value	`Float`	`0.0`
Offset	`Int`	None

Outputs

Name	Type	Description	Default
Value	`Float`		`0.0`

Offset Vector

Evaluate a Vector at an index that is offset by the specified amount

Inputs

Name	Type	Default
Index	`Int`	`Index`
Vector	`Vector`	`Position`
Offset	`Int`	None

Outputs

Name	Type	Description	Default
Value	`Vector`		`[0.0, 0.0, 0.0]`

Offset Boolean

Evaluate a Boolean at an index that is offset by the specified amount

Inputs

Name	Type	Default
Index	`Int`	`Index`
Boolean	`Bool`	`False`
Offset	`Int`	None

Outputs

Name	Type	Description	Default
Boolean	`Bool`		`False`

Offset Rotation

Evaluate a Rotation at an index that is offset by the specified amount

Inputs

Name	Type	Default
Index	`Int`	`Index`
Rotation	`Rotation`	`<Euler (x=0.0000, y=0.0000, z=0.0000), order='XYZ'>`
Offset	`Int`	None

Outputs

Name	Type	Description	Default
Rotation	`Rotation`		`<Euler (x=0.0000, y=0.0000, z=0.0000), order='XYZ'>`

Offset Matrix

Evaluate a 4X4 Matrix at an index that is offset by the specified amount

Inputs

Name	Type	Default
Index	`Int`	`Index`
Matrix	`Matrix`	None
Offset	`Int`	None

Outputs

Name	Type	Description	Default
Matrix	`Matrix`		None

Fallback Float

Use the Float attribute specified by name. If the attribute doesn’t exist, use the Fallback value instead

Inputs

Name	Type	Description	Default
Name	`String`		`_None_`
Fallback	`Float`		`0.0`

Outputs

Name	Type	Description	Default
Value	`Float`		`0.0`

Fallback Vector

Use the Vector attribute specified by name. If the attribute doesn’t exist, use the Fallback value instead

Inputs

Name	Type	Description	Default
Name	`String`		`_None_`
Fallback	`Vector`		`[0.0, 0.0, 0.0]`

Outputs

Name	Type	Description	Default
Output	`Vector`		`[0.0, 0.0, 0.0]`

Fallback Integer

Use the Integer attribute specified by name. If the attribute doesn’t exist, use the Fallback value instead

Inputs

Name	Type	Description	Default
Name	`String`		`_None_`
Fallback	`Int`	Fallback value if Field is 0	None

Outputs

Name	Type	Description	Default
Integer	`Int`		None

Fallback Boolean

Use the Boolean attribute specified by name. If the attribute doesn’t exist, use the Fallback value instead

Computes the boolean field if the given attribute doesn’t exist. If it doesn’t exist it just uses the attribute instead

Inputs

Name	Type	Description	Default
Name	`String`		`_None_`
Fallback	`Bool`		`False`

Outputs

Name	Type	Description	Default
Boolean	`Bool`		`False`

Fallback Color

Use the Color attribute specified by name. If the attribute doesn’t exist, use the Fallback value instead

Inputs

Name	Type	Description	Default
Name	`String`		`Color`
Fallback	`Color`	Fallback value if Field is 0	`[0.072, 0.295, 0.236, 1.0]`

Outputs

Name	Type	Description	Default
Color	`Color`		`[0.0, 0.0, 0.0, 1.0]`

Fallback Rotation

Use the Rotation attribute specified by name. If the attribute doesn’t exist, use the Fallback value instead

Inputs

Name	Type	Description	Default
Name	`String`		`_None_`
Fallback	`Rotation`		`<Euler (x=0.0000, y=0.0000, z=0.0000), order='XYZ'>`

Outputs

Name	Type	Description	Default
Rotation	`Rotation`		`<Euler (x=0.0000, y=0.0000, z=0.0000), order='XYZ'>`

Fallback Matrix

Use the Matrix attribute specified by name. If the attribute doesn’t exist, use the Fallback value instead

Inputs

Name	Type	Description	Default
Name	`String`		`_None_`
Fallback	`Matrix`		None

Outputs

Name	Type	Description	Default
Matrix	`Matrix`		None

Group Pick

For each group, return the index of the point for which the Selection is true. Only valid if there is a single true in the group. If not lvalid, returns -1

Inputs

Name	Type	Description	Default
Pick	`Bool`	True for the item to pick from the group. If number of picks is 0 or more than 1, not a valid pick	`False`
Group ID	`Int`	Group ID inside which to pick the item	None

Outputs

Name	Type	Description	Default
Is Valid	`Bool`	Whether the pick is valid. Pick is only valid if a single item is picked in the Group ID	`True`
Index	`Int`	Index of picked item. Returns -1 if not a valid pick.	None

Group Pick Vector

For each group, return the Position of the point at which the selection is true. If there is more than one true for the group the pick is not valid and (0, 0, 0) is returned

Inputs

Name	Type	Description	Default
Pick	`Bool`		`False`
Group ID	`Int`		None
Position	`Vector`	Vector field to pick vlaue for, defaults to Position	`Position`

Outputs

Name	Type	Description	Default
Is Valid	`Bool`	The pick for this group is valid	`False`
Index	`Int`	Picked Index for the Group	None
Vector	`Vector`	Picked vector for the group	`[0.0, 0.0, 0.0]`

Group Info

Based on the Group ID input, return the size of the group and the indices of the first and last items of the group

Inputs

Name	Type	Description	Default
Group ID	`Int`		None

Outputs

Name	Type	Description	Default
Is First	`Bool`		`False`
First Index	`Int`	Index of the first point in the group	None
Is Last	`Bool`		`False`
Last Index	`Int`	Index of the last point in the group	None
Index in Group	`Int`		None
Size	`Int`	Number of points in the group	None

Attribute Run

Fill in gaps in a set of continuous boolean True values, up to a specific size

Group mask increments whenever the attribute or the Group ID changes

Inputs

Name	Type	Description	Default
Name	`String`		`_None_`
Group ID	`Int`		None

Outputs

Name	Type	Description	Default
Is Different	`Bool`		`False`
Group Mask	`Int`		None

Integer Run

Group mask output increments whenever the input value or the Group ID changes

A unique value for each grouping of a value. Accumulating along the field, the output Group Mask increments by 1 whenever the value or Group ID changes

Inputs

Name	Type	Description	Default
Value	`Int`		None
Group ID	`Int`	Does not restart counting for each Group ID, but does increment by 1 when the Group ID changes	None

Outputs

Name	Type	Description	Default
Is Different	`Bool`	True whenever the value is different to the value that came before it	`False`
Group Mask	`Int`	Group mask increments whenever the Value or the Group ID changes	None

Boolean Run Fill

Fill in gaps in a set of continuous boolean True values, up to a specific size

Inputs

Name	Type	Description	Default
Boolean	`Bool`	Boolean array to fill runs of False	`False`
Fill Size	`Int`	Set a run of False to True if length equal or less than Fill Size	None

Outputs

Name	Type	Description	Default
Boolean	`Bool`		`False`

Boolean Run Mask

Mask a run of boolean values. Potentially trim the start or ending values and specifying a minimum length under which they are considered false

Inputs

Name	Type	Description	Default
Boolean	`Bool`		`False`
Lag Start	`Int`	The first N values in a run are made to be false	None
Min Length	`Int`	Run is only valid if it contains at least N values	None
Trim End	`Int`		None

Outputs

Name	Type	Description	Default
Boolean	`Bool`		`False`