Class Float#
main - nodes - nodes menus
Float DataSocket
Constructor#
Float(self, value=0., label=None)
Content#
Properties
Inherited
bl_idname | bnode | is_multi_input | is_output | is_plugged | links | name | node_chain_label | socket_index
Class and static methods
Angle | Distance | Factor | Frame | Input | Random | Seconds | Value
Inherited
get_bl_idname | get_class_name | gives_bsocket | is_socket | is_vector | python_type_to_socket | value_data_type
Methods
abs | absolute | add | arccos | arccosine | arcsin | arcsine | arctan | arctan2 | arctangent | ceiling | clamp | clamp_min_max | clamp_range | compare | cos | cosh | cosine | divide | equal | exp | exponent | fact | float_curve | floor | fraction | greater_equal | greater_than | inverse_sqrt | less_equal | less_than | log | logarithm | map_range | map_range_linear | map_range_smooth | map_range_smoother | map_range_stepped | math_ceil | math_compare | math_floor | math_greater_than | math_less_than | math_round | math_trunc | math_truncate | max | maximum | min | minimum | mix | modulo | mul_add | multiply | multiply_add | not_equal | ping_pong | pow | power | round | sign | sin | sine | sinh | smooth_maximum | smooth_minimum | snap | sqrt | subtract | switch | tan | tangent | tanh | to_degrees | to_integer | to_radians | to_string | truncate | wrap
Inherited
connected_sockets | get_blender_socket | init_domains | init_socket | plug | reroute | reset_properties | stack | to_output
Properties#
color_ramp#
Node: ColorRamp | Blender reference | api reference
Returns:#
node with sockets [‘color’, ‘alpha’]
Go to top - main - nodes - nodes menus
Class and static methods#
Angle#
@classmethod
def Angle(cls, value=0., name="Angle", min_value = None, max_value = None, description ="")
Create an Angle input socket in the Group Input Node
Args:#
value: The default value
name: The socket name
min_value: Minimum value
max_value: Maximum value
description: User tip
Returns:#
Float: The Float data socket
Go to top - main - nodes - nodes menus
Distance#
@classmethod
def Distance(cls, value=0., name="Distance", min_value = None, max_value = None, description ="")
Create a Distance input socket in the Group Input Node
Args:#
value: The default value
name: The socket name
min_value: Minimum value
max_value: Maximum value
description: User tip
Returns:#
Float: The Float data socket
Go to top - main - nodes - nodes menus
Factor#
@classmethod
def Factor(cls, value=0., name="Factor", min_value = 0., max_value = 1., description ="")
Create a Factor input socket in the Group Input Node
Args:#
value: The default value
name: The socket name
min_value: Minimum value
max_value: Maximum value
description: User tip
Returns:#
Float: The Float data socket
Go to top - main - nodes - nodes menus
Frame#
@classmethod
def Frame(cls)
Node: Scene Time | Blender reference | api reference
Returns:#
socket
frame
Go to top - main - nodes - nodes menus
Input#
@classmethod
def Input(cls, value = 0., name = "Float", min_value = None, max_value = None, description ="")
Create a Float input socket in the Group Input Node
Args:#
value: The default value
name: The socket name
min_value: Minimum value
max_value: Maximum value
description: User tip
Returns:#
Float: The Float data socket
Go to top - main - nodes - nodes menus
Random#
@classmethod
def Random(cls, min=None, max=None, ID=None, seed=None)
Node: Random Value | Blender reference | api reference
Args:#
min: [‘Vector’, ‘Float’, ‘Integer’]
max: [‘Vector’, ‘Float’, ‘Integer’]
ID: Integer
seed: Integer
Returns:#
socket
value
Go to top - main - nodes - nodes menus
Seconds#
@classmethod
def Seconds(cls)
Node: Scene Time | Blender reference | api reference
Returns:#
socket
seconds
Go to top - main - nodes - nodes menus
Value#
@classmethod
def Value(cls)
Node: Value | Blender reference | api reference
Returns:#
socket
value
Go to top - main - nodes - nodes menus
Methods#
abs#
def abs(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
absolute#
def absolute(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
add#
def add(self, value=None, node_label = None, node_color = None)
Add two values.
Args:#
value: Float
node_label (str): Node label
node_color (color): Node background color
Returns:#
Float
If value is a Vector or a Color, VectorMath node is used rather than Math.
Go to top - main - nodes - nodes menus
arccos#
def arccos(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
arccosine#
def arccosine(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
arcsin#
def arcsin(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
arcsine#
def arcsine(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
arctan#
def arctan(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
arctan2#
def arctan2(self, value1=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value1: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
arctangent#
def arctangent(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
ceiling#
def ceiling(self)
Node: Float to Integer | Blender reference | api reference
Returns:#
socket
integer
Go to top - main - nodes - nodes menus
clamp#
def clamp(self, min=None, max=None, clamp_type='MINMAX')
Node: Clamp | Blender reference | api reference
Args:#
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(self, min=None, max=None)
Node: Clamp | Blender reference | api reference
Args:#
min: Float
max: Float
Returns:#
socket
result
Go to top - main - nodes - nodes menus
clamp_range#
def clamp_range(self, min=None, max=None)
Node: Clamp | Blender reference | api reference
Args:#
min: Float
max: Float
Returns:#
socket
result
Go to top - main - nodes - nodes menus
compare#
def compare(self, b=None, epsilon=None, operation='GREATER_THAN')
Node: Compare | Blender reference | api reference
Args:#
b: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘String’]
epsilon: Float
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(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
cosh#
def cosh(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
cosine#
def cosine(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
divide#
def divide(self, value=None, node_label = None, node_color = None)
Divide two values.
Args:#
value: Float
node_label (str): Node label
node_color (color): Node background color
Returns:#
Float
If value is a Vector or a Color, VectorMath node is used rather than Math.
Go to top - main - nodes - nodes menus
equal#
def equal(self, b=None, epsilon=None)
Node: Compare | Blender reference | api reference
Args:#
b: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘String’]
epsilon: Float
Returns:#
socket
result
Go to top - main - nodes - nodes menus
exp#
def exp(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
exponent#
def exponent(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
fact#
def fact(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
float_curve#
def float_curve(self, factor=None)
Node: Float Curve | Blender reference | api reference
Args:#
factor: Float
Returns:#
socket
value
Go to top - main - nodes - nodes menus
floor#
def floor(self)
Node: Float to Integer | Blender reference | api reference
Returns:#
socket
integer
Go to top - main - nodes - nodes menus
fraction#
def fraction(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
greater_equal#
def greater_equal(self, b=None)
Node: Compare | Blender reference | api reference
Args:#
b: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘String’]
Returns:#
socket
result
Go to top - main - nodes - nodes menus
greater_than#
def greater_than(self, b=None)
Node: Compare | Blender reference | api reference
Args:#
b: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘String’]
Returns:#
socket
result
Go to top - main - nodes - nodes menus
inverse_sqrt#
def inverse_sqrt(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
less_equal#
def less_equal(self, b=None)
Node: Compare | Blender reference | api reference
Args:#
b: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘String’]
Returns:#
socket
result
Go to top - main - nodes - nodes menus
less_than#
def less_than(self, b=None)
Node: Compare | Blender reference | api reference
Args:#
b: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘String’]
Returns:#
socket
result
Go to top - main - nodes - nodes menus
log#
def log(self, base=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
base: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
logarithm#
def logarithm(self, base=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
base: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
map_range#
def map_range(self, from_min=None, from_max=None, to_min=None, to_max=None, steps=None, clamp=True, interpolation_type='LINEAR')
Node: Map Range | Blender reference | api reference
Args:#
from_min: [‘Float’, ‘Vector’]
from_max: [‘Float’, ‘Vector’]
to_min: [‘Float’, ‘Vector’]
to_max: [‘Float’, ‘Vector’]
steps: [‘Float’, ‘Vector’]
clamp (bool): True
interpolation_type (str): ‘LINEAR’ in [LINEAR, STEPPED, SMOOTHSTEP, SMOOTHERSTEP]
Returns:#
socket
result
Go to top - main - nodes - nodes menus
map_range_linear#
def map_range_linear(self, from_min=None, from_max=None, to_min=None, to_max=None, clamp=True)
Node: Map Range | Blender reference | api reference
Args:#
from_min: [‘Float’, ‘Vector’]
from_max: [‘Float’, ‘Vector’]
to_min: [‘Float’, ‘Vector’]
to_max: [‘Float’, ‘Vector’]
clamp (bool): True
Returns:#
socket
result
Go to top - main - nodes - nodes menus
map_range_smooth#
def map_range_smooth(self, from_min=None, from_max=None, to_min=None, to_max=None, clamp=True)
Node: Map Range | Blender reference | api reference
Args:#
from_min: [‘Float’, ‘Vector’]
from_max: [‘Float’, ‘Vector’]
to_min: [‘Float’, ‘Vector’]
to_max: [‘Float’, ‘Vector’]
clamp (bool): True
Returns:#
socket
result
Go to top - main - nodes - nodes menus
map_range_smoother#
def map_range_smoother(self, from_min=None, from_max=None, to_min=None, to_max=None, clamp=True)
Node: Map Range | Blender reference | api reference
Args:#
from_min: [‘Float’, ‘Vector’]
from_max: [‘Float’, ‘Vector’]
to_min: [‘Float’, ‘Vector’]
to_max: [‘Float’, ‘Vector’]
clamp (bool): True
Returns:#
socket
result
Go to top - main - nodes - nodes menus
map_range_stepped#
def map_range_stepped(self, from_min=None, from_max=None, to_min=None, to_max=None, steps=None, clamp=True)
Node: Map Range | Blender reference | api reference
Args:#
from_min: [‘Float’, ‘Vector’]
from_max: [‘Float’, ‘Vector’]
to_min: [‘Float’, ‘Vector’]
to_max: [‘Float’, ‘Vector’]
steps: [‘Float’, ‘Vector’]
clamp (bool): True
Returns:#
socket
result
Go to top - main - nodes - nodes menus
math_ceil#
def math_ceil(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
math_compare#
def math_compare(self, value=None, epsilon=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
epsilon: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
math_floor#
def math_floor(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
math_greater_than#
def math_greater_than(self, threshold=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
threshold: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
math_less_than#
def math_less_than(self, threshold=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
threshold: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
math_round#
def math_round(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
math_trunc#
def math_trunc(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
math_truncate#
def math_truncate(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
max#
def max(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
maximum#
def maximum(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
min#
def min(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
minimum#
def minimum(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
mix#
def mix(self, factor=None, value=None, clamp_factor=True)
Node: Mix | Blender reference | api reference
Args:#
factor: [‘Float’, ‘Vector’]
value: [‘Float’, ‘Vector’, ‘Color’]
clamp_factor (bool): True
Returns:#
socket
result
Go to top - main - nodes - nodes menus
modulo#
def modulo(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
mul_add#
def mul_add(self, multiplier=None, addend=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
multiplier: Float
addend: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
multiply#
def multiply(self, value=None, node_label = None, node_color = None)
Multiply two values.
Args:#
value: Float
node_label (str): Node label
node_color (color): Node background color
Returns:#
Float
If value is a Vector or a Color, VectorMath node is used rather than Math.
Go to top - main - nodes - nodes menus
multiply_add#
def multiply_add(self, multiplier=None, addend=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
multiplier: Float
addend: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
not_equal#
def not_equal(self, b=None, epsilon=None)
Node: Compare | Blender reference | api reference
Args:#
b: [‘Float’, ‘Integer’, ‘Vector’, ‘Color’, ‘String’]
epsilon: Float
Returns:#
socket
result
Go to top - main - nodes - nodes menus
ping_pong#
def ping_pong(self, scale=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
scale: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
pow#
def pow(self, exponent=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
exponent: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
power#
def power(self, exponent=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
exponent: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
round#
def round(self)
Node: Float to Integer | Blender reference | api reference
Returns:#
socket
integer
Go to top - main - nodes - nodes menus
sign#
def sign(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
sin#
def sin(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
sine#
def sine(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
sinh#
def sinh(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
smooth_maximum#
def smooth_maximum(self, value=None, distance=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
distance: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
smooth_minimum#
def smooth_minimum(self, value=None, distance=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
distance: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
snap#
def snap(self, increment=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
increment: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
sqrt#
def sqrt(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
subtract#
def subtract(self, value=None, node_label = None, node_color = None)
Subtract two values.
Args:#
value: Float
node_label (str): Node label
node_color (color): Node background color
Returns:#
Float
If value is a Vector or a Color, VectorMath node is used rather than Math.
Go to top - main - nodes - nodes menus
switch#
def switch(self, switch=None, true=None)
Node: Switch | Blender reference | api reference
Args:#
switch: Boolean
true: Float
Returns:#
socket
output
Go to top - main - nodes - nodes menus
tan#
def tan(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
tangent#
def tangent(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
tanh#
def tanh(self, value=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
value: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
to_degrees#
def to_degrees(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
to_integer#
def to_integer(self, rounding_mode='ROUND')
Node: Float to Integer | Blender reference | api reference
Args:#
rounding_mode (str): ‘ROUND’ in [ROUND, FLOOR, CEILING, TRUNCATE]
Returns:#
socket
integer
Go to top - main - nodes - nodes menus
to_radians#
def to_radians(self, clamp=False)
Node: Math | Blender reference | api reference
Args:#
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus
to_string#
def to_string(self, decimals=None)
Node: Value to String | Blender reference | api reference
Args:#
decimals: Integer
Returns:#
socket
string
Go to top - main - nodes - nodes menus
truncate#
def truncate(self)
Node: Float to Integer | Blender reference | api reference
Returns:#
socket
integer
Go to top - main - nodes - nodes menus
wrap#
def wrap(self, max=None, min=None, clamp=False)
Node: Math | Blender reference | api reference
Args:#
max: Float
min: Float
clamp (bool): False
Returns:#
socket
value
Go to top - main - nodes - nodes menus