Class Integer#

Integer DataSocket

Constructor#

Integer(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

Input | Integer | Random | Unsigned

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 | compare | cos | cosh | cosine | divide | equal | exp | exponent | fact | fraction | greater_equal | greater_than | inverse_sqrt | less_equal | less_than | log | logarithm | math_ceil | math_compare | math_floor | math_greater_than | math_less_than | math_round | math_trunc | math_truncate | max | maximum | min | minimum | modulo | mul_add | multiply | multiply_add | not_equal | ping_pong | pow | power | sign | sin | sine | sinh | smooth_maximum | smooth_minimum | snap | sqrt | subtract | switch | tan | tangent | tanh | to_degrees | to_radians | to_string | wrap

Inherited

connected_sockets | get_blender_socket | init_domains | init_socket | plug | reroute | reset_properties | stack | to_output

Class and static methods#

Input#

@classmethod
def Input(cls, value = 0, name = "Integer", min_value = None, max_value = None, description = "")

Create an Integer 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:#

  • Integer: The Integer data socket

Go to top - main - nodes - nodes menus

Integer#

@classmethod
def Integer(cls, integer=0)

Args:#

  • integer (int): 0

Returns:#

  • socket integer

Go to top - main - nodes - nodes menus

Random#

@classmethod
def Random(cls, 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

Unsigned#

@classmethod
def Unsigned(cls, value = 0, name = "Unsigned", min_value = 0, max_value = None, description = "")

Create an Unisgned Integer 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:#

  • Integer: The Integer data socket

Go to top - main - nodes - nodes menus

Methods#

abs#

def abs(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

absolute#

def absolute(self, clamp=False)

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)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arccosine#

def arccosine(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arcsin#

def arcsin(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arcsine#

def arcsine(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arctan#

def arctan(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arctan2#

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

Args:#

  • value1: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

arctangent#

def arctangent(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

compare#

def compare(self, b=None, operation='GREATER_THAN')

Args:#

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

  • 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)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

cosh#

def cosh(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

cosine#

def cosine(self, value=None, clamp=False)

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)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

exp#

def exp(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

exponent#

def exponent(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

fact#

def fact(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

fraction#

def fraction(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

greater_equal#

def greater_equal(self, b=None)

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)

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)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

less_equal#

def less_equal(self, b=None)

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)

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)

Args:#

  • base: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

logarithm#

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

Args:#

  • base: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_ceil#

def math_ceil(self, clamp=False)

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)

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)

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)

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)

Args:#

  • threshold: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_round#

def math_round(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_trunc#

def math_trunc(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

math_truncate#

def math_truncate(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

max#

def max(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

maximum#

def maximum(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

min#

def min(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

minimum#

def minimum(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

modulo#

def modulo(self, value=None, clamp=False)

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)

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)

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)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

ping_pong#

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

Args:#

  • scale: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

pow#

def pow(self, exponent=None, clamp=False)

Args:#

  • exponent: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

power#

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

Args:#

  • exponent: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sign#

def sign(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sin#

def sin(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sine#

def sine(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sinh#

def sinh(self, value=None, clamp=False)

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)

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)

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)

Args:#

  • increment: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

sqrt#

def sqrt(self, clamp=False)

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)

Args:#

  • switch: Boolean

  • true: Integer

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

tan#

def tan(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

tangent#

def tangent(self, value=None, clamp=False)

Args:#

  • value: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

tanh#

def tanh(self, 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(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

to_radians#

def to_radians(self, clamp=False)

Args:#

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

to_string#

def to_string(self)

Returns:#

  • socket string

Go to top - main - nodes - nodes menus

wrap#

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

Args:#

  • max: Float

  • min: Float

  • clamp (bool): False

Returns:#

  • socket value

Go to top - main - nodes - nodes menus