Global functions#

Content#

abs | absolute | align_euler_to_vector | arccos | arccosine | arcsin | arcsine | arctan | arctan2 | arctangent | b_and | b_not | b_or | clamp | clamp_min_max | clamp_range | color_add | color_burn | color_color | color_darken | color_difference | color_divide | color_dodge | color_hue | color_lighten | color_linear_light | color_mix | color_multiply | color_overlay | color_ramp | color_saturation | color_screen | color_soft_light | color_subtract | color_value | combine_hsl | combine_hsv | combine_rgb | compare | cos | cosh | cosine | exp | exponent | float_mix | fraction | geometry_to_instance | imply | inverse_sqrt | join_geometry | join_strings | log | logarithm | math | math_ceil | math_compare | math_floor | math_greater_than | math_less_than | math_round | math_trun | math_truncate | max | maximum | min | minimum | modulo | mul_add | multiply_add | nand | nimply | nor | ping_pong | power | random_boolean | random_float | random_integer | random_vector | replace_string | rgb_curves | rotate_axis_angle | rotate_euler | separate_hsl | separate_hsv | separate_rgb | sign | sin | sine | sinh | slice_string | smooth_maximum | smooth_minimum | snap | sqrt | string_length | string_to_curves | switch | switch_boolean | switch_collection | switch_color | switch_float | switch_geometry | switch_image | switch_integer | switch_material | switch_object | switch_string | switch_texture | switch_vector | tan | tangent | tanh | to_degrees | to_radians | value_to_string | vector_mix | wrap | xnor | xor

abs#

def abs(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

absolute#

def absolute(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

align_euler_to_vector#

def align_euler_to_vector(rotation=None, factor=None, vector=None, axis='X', pivot_axis='AUTO')

Args:#

  • rotation: Vector

  • factor: Float

  • vector: Vector

  • axis (str): ‘X’ in [X, Y, Z]

  • pivot_axis (str): ‘AUTO’ in [AUTO, X, Y, Z]

Returns:#

  • socket rotation

Go to top - main - nodes - nodes menus

arccos#

def arccos(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arccosine#

def arccosine(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arcsin#

def arcsin(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arcsine#

def arcsine(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arctan#

def arctan(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arctan2#

def arctan2(value0=None, value1=None, clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arctangent#

def arctangent(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

b_and#

def b_and(boolean0=None, boolean1=None)

Args:#

  • boolean0: Boolean

  • boolean1: Boolean

Returns:#

  • socket boolean

Go to top - main - nodes - nodes menus

b_not#

def b_not(boolean0=None)

Args:#

  • boolean0: Boolean

Returns:#

  • socket boolean

Go to top - main - nodes - nodes menus

b_or#

def b_or(boolean0=None, boolean1=None)

Args:#

  • boolean0: Boolean

  • boolean1: Boolean

Returns:#

  • socket boolean

Go to top - main - nodes - nodes menus

clamp#

def clamp(value=None, min=None, max=None, clamp_type='MINMAX')

Args:#

  • value: Float

  • min: Float

  • max: Float

  • clamp_type (str): ‘MINMAX’ in [MINMAX, RANGE]

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

clamp_min_max#

def clamp_min_max(value=None, min=None, max=None)

Args:#

  • value: Float

  • min: Float

  • max: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

clamp_range#

def clamp_range(value=None, min=None, max=None)

Args:#

  • value: Float

  • min: Float

  • max: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_add#

def color_add(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_burn#

def color_burn(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_color#

def color_color(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_darken#

def color_darken(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_difference#

def color_difference(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_divide#

def color_divide(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_dodge#

def color_dodge(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_hue#

def color_hue(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_lighten#

def color_lighten(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_linear_light#

def color_linear_light(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_mix#

def color_mix(factor=None, a=None, b=None, blend_type='MIX', clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • blend_type (str): ‘MIX’ in [MIX, DARKEN, MULTIPLY, BURN, LIGHTEN,… , SATURATION, COLOR, VALUE]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_multiply#

def color_multiply(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_overlay#

def color_overlay(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_ramp#

def color_ramp(fac=None)

Args:#

  • fac: Float

Returns:#

  • node with sockets [‘color’, ‘alpha’]

Go to top - main - nodes - nodes menus

color_saturation#

def color_saturation(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_screen#

def color_screen(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_soft_light#

def color_soft_light(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_subtract#

def color_subtract(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

color_value#

def color_value(factor=None, a=None, b=None, clamp_factor=True, clamp_result=False)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • clamp_result (bool): False

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

combine_hsl#

def combine_hsl(hue=None, saturation=None, lightness=None, alpha=None)

Args:#

  • hue: Float

  • saturation: Float

  • lightness: Float

  • alpha: Float

Returns:#

  • socket color

Go to top - main - nodes - nodes menus

combine_hsv#

def combine_hsv(hue=None, saturation=None, value=None, alpha=None)

Args:#

  • hue: Float

  • saturation: Float

  • value: Float

  • alpha: Float

Returns:#

  • socket color

Go to top - main - nodes - nodes menus

combine_rgb#

def combine_rgb(red=None, green=None, blue=None, alpha=None)

Args:#

  • red: Float

  • green: Float

  • blue: Float

  • alpha: Float

Returns:#

  • socket color

Go to top - main - nodes - nodes menus

compare#

def compare(a=None, b=None, c=None, angle=None, epsilon=None, data_type='FLOAT', mode='ELEMENT', operation='GREATER_THAN')

Args:#

  • a: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘String’]

  • b: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘String’]

  • c: Float

  • angle: Float

  • epsilon: Float

  • data_type (str): ‘FLOAT’ in [FLOAT, INT, VECTOR, STRING, RGBA]

  • mode (str): ‘ELEMENT’ in [ELEMENT, LENGTH, AVERAGE, DOT_PRODUCT, DIRECTION]

  • operation (str): ‘GREATER_THAN’ in [LESS_THAN, LESS_EQUAL, GREATER_THAN, GREATER_EQUAL, EQUAL, NOT_EQUAL]

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

cos#

def cos(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

cosh#

def cosh(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

cosine#

def cosine(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

exp#

def exp(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

exponent#

def exponent(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

float_mix#

def float_mix(factor=None, a=None, b=None, clamp_factor=True)

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

fraction#

def fraction(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

geometry_to_instance#

def geometry_to_instance(*geometry)

Args:#

  • geometry: Geometry

Returns:#

  • socket instances of class Instances

Go to top - main - nodes - nodes menus

imply#

def imply(boolean0=None, boolean1=None)

Args:#

  • boolean0: Boolean

  • boolean1: Boolean

Returns:#

  • socket boolean

Go to top - main - nodes - nodes menus

inverse_sqrt#

def inverse_sqrt(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

join_geometry#

def join_geometry(*geometry)

Args:#

  • geometry: Geometry

Returns:#

  • socket geometry

Go to top - main - nodes - nodes menus

join_strings#

def join_strings(*strings, delimiter=None)

Args:#

  • strings: String

  • delimiter: String

Returns:#

  • socket string

Go to top - main - nodes - nodes menus

log#

def log(value=None, base=None, clamp=False)

Args:#

  • value: Float

  • base: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

logarithm#

def logarithm(value=None, base=None, clamp=False)

Args:#

  • value: Float

  • base: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math#

def math(value0=None, value1=None, value2=None, operation='ADD', clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • value2: Float

  • operation (str): ‘ADD’ in [ADD, SUBTRACT, MULTIPLY, DIVIDE,… , TANH, RADIANS, DEGREES]

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_ceil#

def math_ceil(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_compare#

def math_compare(value0=None, value1=None, epsilon=None, clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • epsilon: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_floor#

def math_floor(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_greater_than#

def math_greater_than(value=None, threshold=None, clamp=False)

Args:#

  • value: Float

  • threshold: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_less_than#

def math_less_than(value=None, threshold=None, clamp=False)

Args:#

  • value: Float

  • threshold: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_round#

def math_round(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_trun#

def math_trun(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_truncate#

def math_truncate(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

max#

def max(value0=None, value1=None, clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

maximum#

def maximum(value0=None, value1=None, clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

min#

def min(value0=None, value1=None, clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

minimum#

def minimum(value0=None, value1=None, clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

modulo#

def modulo(value0=None, value1=None, clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

mul_add#

def mul_add(value=None, multiplier=None, addend=None, clamp=False)

Args:#

  • value: Float

  • multiplier: Float

  • addend: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

multiply_add#

def multiply_add(value=None, multiplier=None, addend=None, clamp=False)

Args:#

  • value: Float

  • multiplier: Float

  • addend: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

nand#

def nand(boolean0=None, boolean1=None)

Args:#

  • boolean0: Boolean

  • boolean1: Boolean

Returns:#

  • socket boolean

Go to top - main - nodes - nodes menus

nimply#

def nimply(boolean0=None, boolean1=None)

Args:#

  • boolean0: Boolean

  • boolean1: Boolean

Returns:#

  • socket boolean

Go to top - main - nodes - nodes menus

nor#

def nor(boolean0=None, boolean1=None)

Args:#

  • boolean0: Boolean

  • boolean1: Boolean

Returns:#

  • socket boolean

Go to top - main - nodes - nodes menus

ping_pong#

def ping_pong(value=None, scale=None, clamp=False)

Args:#

  • value: Float

  • scale: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

power#

def power(base=None, exponent=None, clamp=False)

Args:#

  • base: Float

  • exponent: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

random_boolean#

def random_boolean(probability=None, ID=None, seed=None)

Args:#

  • probability: Float

  • ID: Integer

  • seed: Integer

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

random_float#

def random_float(min=None, max=None, ID=None, seed=None)

Args:#

  • min: [‘Vector’, ‘Float’, ‘Integer’]

  • max: [‘Vector’, ‘Float’, ‘Integer’]

  • ID: Integer

  • seed: Integer

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

random_integer#

def random_integer(min=None, max=None, ID=None, seed=None)

Args:#

  • min: [‘Vector’, ‘Float’, ‘Integer’]

  • max: [‘Vector’, ‘Float’, ‘Integer’]

  • ID: Integer

  • seed: Integer

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

random_vector#

def random_vector(min=None, max=None, ID=None, seed=None)

Args:#

  • min: [‘Vector’, ‘Float’, ‘Integer’]

  • max: [‘Vector’, ‘Float’, ‘Integer’]

  • ID: Integer

  • seed: Integer

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

replace_string#

def replace_string(string=None, find=None, replace=None)

Args:#

  • string: String

  • find: String

  • replace: String

Returns:#

  • socket string

Go to top - main - nodes - nodes menus

rgb_curves#

def rgb_curves(fac=None, color=None)

Args:#

  • fac: Float

  • color: Color

Returns:#

  • node with sockets [‘color’]

Go to top - main - nodes - nodes menus

rotate_axis_angle#

def rotate_axis_angle(rotation=None, axis=None, angle=None, space='OBJECT')

Args:#

  • rotation: Vector

  • axis: Vector

  • angle: Float

  • space (str): ‘OBJECT’ in [OBJECT, LOCAL]

Returns:#

  • socket rotation

Go to top - main - nodes - nodes menus

rotate_euler#

def rotate_euler(rotation=None, rotate_by=None, space='OBJECT')

Args:#

  • rotation: Vector

  • rotate_by: Vector

  • space (str): ‘OBJECT’ in [OBJECT, LOCAL]

Returns:#

  • socket rotation

Go to top - main - nodes - nodes menus

separate_hsl#

def separate_hsl(color=None)

Args:#

  • color: Color

Node Image

Returns:#

  • tuple (’red’, ‘green’, ‘blue’, ‘alpha’)

Go to top - main - nodes - nodes menus

separate_hsv#

def separate_hsv(color=None)

Args:#

  • color: Color

Node Image

Returns:#

  • tuple (’red’, ‘green’, ‘blue’, ‘alpha’)

Go to top - main - nodes - nodes menus

separate_rgb#

def separate_rgb(color=None)

Args:#

  • color: Color

Node Image

Returns:#

  • tuple (’red’, ‘green’, ‘blue’, ‘alpha’)

Go to top - main - nodes - nodes menus

sign#

def sign(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sin#

def sin(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sine#

def sine(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sinh#

def sinh(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

slice_string#

def slice_string(string=None, position=None, length=None)

Args:#

  • string: String

  • position: Integer

  • length: Integer

Returns:#

  • socket string

Go to top - main - nodes - nodes menus

smooth_maximum#

def smooth_maximum(value0=None, value1=None, distance=None, clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • distance: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

smooth_minimum#

def smooth_minimum(value0=None, value1=None, distance=None, clamp=False)

Args:#

  • value0: Float

  • value1: Float

  • distance: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

snap#

def snap(value=None, increment=None, clamp=False)

Args:#

  • value: Float

  • increment: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sqrt#

def sqrt(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

string_length#

def string_length(string=None)

Args:#

  • string: String

Returns:#

  • socket length

Go to top - main - nodes - nodes menus

string_to_curves#

def string_to_curves(string=None, size=None, character_spacing=None, word_spacing=None, line_spacing=None, text_box_width=None, text_box_height=None, align_x='LEFT', align_y='TOP_BASELINE', overflow='OVERFLOW', pivot_mode='BOTTOM_LEFT')

Args:#

  • string: String

  • size: Float

  • character_spacing: Float

  • word_spacing: Float

  • line_spacing: Float

  • text_box_width: Float

  • text_box_height: Float

  • align_x (str): ‘LEFT’ in [LEFT, CENTER, RIGHT, JUSTIFY, FLUSH]

  • align_y (str): ‘TOP_BASELINE’ in [TOP_BASELINE, TOP, MIDDLE, BOTTOM_BASELINE, BOTTOM]

  • overflow (str): ‘OVERFLOW’ in [OVERFLOW, SCALE_TO_FIT, TRUNCATE]

  • pivot_mode (str): ‘BOTTOM_LEFT’ in [MIDPOINT, TOP_LEFT, TOP_CENTER,… , BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT]

Node Image

Returns:#

  • tuple (’curve_instances’, ‘line’, ‘pivot_point’)

Go to top - main - nodes - nodes menus

switch#

def switch(switch=None, false=None, true=None, input_type='GEOMETRY')

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • input_type (str): ‘GEOMETRY’ in [FLOAT, INT, BOOLEAN, VECTOR, STRING,… , COLLECTION, TEXTURE, MATERIAL]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_boolean#

def switch_boolean(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_collection#

def switch_collection(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_color#

def switch_color(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_float#

def switch_float(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_geometry#

def switch_geometry(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_image#

def switch_image(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_integer#

def switch_integer(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_material#

def switch_material(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_object#

def switch_object(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_string#

def switch_string(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_texture#

def switch_texture(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

switch_vector#

def switch_vector(switch=None, false=None, true=None)

Args:#

  • switch: [‘Boolean’, ‘Boolean’]

  • false: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

  • true: [‘Float’, ‘Integer’, ‘Boolean’, ‘Vector’, ‘Color’, ‘String’, ‘Geometry’, ‘Object’, ‘Collection’, ‘Texture’, ‘Material’, ‘Image’]

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

tan#

def tan(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

tangent#

def tangent(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

tanh#

def tanh(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

to_degrees#

def to_degrees(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

to_radians#

def to_radians(value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

value_to_string#

def value_to_string(value=None, decimals=None)

Args:#

  • value: Float

  • decimals: Integer

Returns:#

  • socket string

Go to top - main - nodes - nodes menus

vector_mix#

def vector_mix(factor=None, a=None, b=None, clamp_factor=True, factor_mode='UNIFORM')

Args:#

  • factor: [‘Float’, ‘Vector’]

  • a: [‘Float’, ‘Vector’, ‘Color’]

  • b: [‘Float’, ‘Vector’, ‘Color’]

  • clamp_factor (bool): True

  • factor_mode (str): ‘UNIFORM’ in [UNIFORM, NON_UNIFORM]

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

wrap#

def wrap(value=None, max=None, min=None, clamp=False)

Args:#

  • value: Float

  • max: Float

  • min: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

xnor#

def xnor(boolean0=None, boolean1=None)

Args:#

  • boolean0: Boolean

  • boolean1: Boolean

Returns:#

  • socket boolean

Go to top - main - nodes - nodes menus

xor#

def xor(boolean0=None, boolean1=None)

Args:#

  • boolean0: Boolean

  • boolean1: Boolean

Returns:#

  • socket boolean

Go to top - main - nodes - nodes menus