Class Vector#

Vector DataSocket

Vector exposes properties: x, y and z:

v = Vector()
v.x = 1
v.y = 2

# Translate the vertices have been translated of (1, 2, 0)
geometry.verts.offset = v    




### Constructor

```python
Vector(self, value=(0., 0., 0.), label=None)

Content#

Properties

length | separate

Inherited

bl_idname | bnode | is_multi_input | is_output | is_plugged | links | name | node_chain_label | socket_index

Class and static methods

AlignToVector | Combine | Input | Random | Rotation | Translation | Vector | VectorXYZ

Inherited

get_bl_idname | get_class_name | gives_bsocket | is_socket | is_vector | python_type_to_socket | value_data_type

Methods

abs | absolute | add | align_euler_to_vector | average_equal | average_greater_equal | average_greater_than | average_less_equal | average_less_than | average_not_equal | ceil | compare | cos | cosine | cross | cross_product | curves | direction_equal | direction_greater_equal | direction_greater_than | direction_less_equal | direction_less_than | direction_not_equal | distance | div | divide | dot | dot_product | dot_product_equal | dot_product_greater_equal | dot_product_greater_than | dot_product_less_equal | dot_product_less_than | dot_product_not_equal | elements_equal | elements_greater_equal | elements_greater_than | elements_less_equal | elements_less_than | elements_not_equal | face_forward | floor | fract | fraction | get_blender_socket | length_equal | length_greater_equal | length_greater_than | length_less_equal | length_less_than | length_not_equal | map_range | map_range_linear | map_range_smooth | map_range_smoother | map_range_stepped | max | maximum | min | minimum | mix | mix_non_uniform | mix_uniform | modulo | mul | mul_add | multiply | multiply_add | normalize | project | reflect | refract | rotate_axis_angle | rotate_euler | rotate_x | rotate_y | rotate_z | scale | sin | sine | snap | sub | subtract | switch | tan | tangent | wrap

Inherited

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

Properties#

length#

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

separate#

Returns:#

  • node with sockets [‘x’, ‘y’, ‘z’]

Go to top - main - nodes - nodes menus

Class and static methods#

AlignToVector#

@classmethod
def AlignToVector(cls, factor=None, vector=None, axis='X', pivot_axis='AUTO')

Args:#

  • 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

Combine#

@classmethod
def Combine(cls, x=None, y=None, z=None)

Args:#

  • x: Float

  • y: Float

  • z: Float

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

Input#

@classmethod
def Input(cls, value = (0, 0, 0), name = "Vector", description = "")

Create a Vector input socket in the Group Input Node

Args:#

  • value: The default value

  • name: The socket name

  • description: User tip

Returns:#

  • Vector: The Vector data socket

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

Rotation#

@classmethod
def Rotation(cls, value = (0, 0, 0), name = "Rotation", description = "")

Create a Rotation input socket in the Group Input Node

Args:#

  • value: The default value

  • name: The socket name

  • description: User tip

Returns:#

  • Vector: The Vector data socket

Go to top - main - nodes - nodes menus

Translation#

@classmethod
def Translation(cls, value =(0, 0, 0), name = "Translation", description = "")

Create a Translation input socket in the Group Input Node

Args:#

  • value: The default value

  • name: The socket name

  • description: User tip

Returns:#

  • Vector: The Vector data socket

Go to top - main - nodes - nodes menus

Vector#

@classmethod
def Vector(cls, vector=[0.0, 0.0, 0.0])

Args:#

  • vector (list): [0.0, 0.0, 0.0]

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

VectorXYZ#

@classmethod
def VectorXYZ(cls, value = (0, 0, 0), name = "VectorXYZ", description = "")

Create a Vector XYZ input socket in the Group Input Node

Args:#

  • value: The default value

  • name: The socket name

  • description: User tip

Returns:#

  • Vector: The Vector data socket

Go to top - main - nodes - nodes menus

Methods#

abs#

def abs(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

absolute#

def absolute(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

add#

def add(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

align_euler_to_vector#

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

Args:#

  • factor: Float

  • vector: Vector

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

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

Returns:#

  • self

Go to top - main - nodes - nodes menus

average_equal#

def average_equal(self, b=None, epsilon=None)

Args:#

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

  • epsilon: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

average_greater_equal#

def average_greater_equal(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

average_greater_than#

def average_greater_than(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

average_less_equal#

def average_less_equal(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

average_less_than#

def average_less_than(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

average_not_equal#

def average_not_equal(self, b=None, epsilon=None)

Args:#

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

  • epsilon: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

ceil#

def ceil(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

compare#

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

Args:#

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

  • c: Float

  • angle: Float

  • epsilon: Float

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

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

cosine#

def cosine(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

cross#

def cross(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

cross_product#

def cross_product(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

curves#

def curves(self, fac=None)

Args:#

  • fac: Float

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

direction_equal#

def direction_equal(self, b=None, angle=None, epsilon=None)

Args:#

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

  • angle: Float

  • epsilon: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

direction_greater_equal#

def direction_greater_equal(self, b=None, angle=None)

Args:#

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

  • angle: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

direction_greater_than#

def direction_greater_than(self, b=None, angle=None)

Args:#

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

  • angle: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

direction_less_equal#

def direction_less_equal(self, b=None, angle=None)

Args:#

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

  • angle: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

direction_less_than#

def direction_less_than(self, b=None, angle=None)

Args:#

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

  • angle: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

direction_not_equal#

def direction_not_equal(self, b=None, angle=None, epsilon=None)

Args:#

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

  • angle: Float

  • epsilon: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

distance#

def distance(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

div#

def div(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

divide#

def divide(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

dot#

def dot(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

dot_product#

def dot_product(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket value

Go to top - main - nodes - nodes menus

dot_product_equal#

def dot_product_equal(self, b=None, c=None, epsilon=None)

Args:#

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

  • c: Float

  • epsilon: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

dot_product_greater_equal#

def dot_product_greater_equal(self, b=None, c=None)

Args:#

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

  • c: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

dot_product_greater_than#

def dot_product_greater_than(self, b=None, c=None)

Args:#

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

  • c: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

dot_product_less_equal#

def dot_product_less_equal(self, b=None, c=None)

Args:#

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

  • c: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

dot_product_less_than#

def dot_product_less_than(self, b=None, c=None)

Args:#

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

  • c: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

dot_product_not_equal#

def dot_product_not_equal(self, b=None, c=None, epsilon=None)

Args:#

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

  • c: Float

  • epsilon: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

elements_equal#

def elements_equal(self, b=None, epsilon=None)

Args:#

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

  • epsilon: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

elements_greater_equal#

def elements_greater_equal(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

elements_greater_than#

def elements_greater_than(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

elements_less_equal#

def elements_less_equal(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

elements_less_than#

def elements_less_than(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

elements_not_equal#

def elements_not_equal(self, b=None, epsilon=None)

Args:#

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

  • epsilon: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

face_forward#

def face_forward(self, incident=None, reference=None)

Args:#

  • incident: Vector

  • reference: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

floor#

def floor(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

fract#

def fract(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

fraction#

def fraction(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

get_blender_socket#

def get_blender_socket(self)

Overrides the standard behavior of :class:DataSocket super class

If the x, y, z properties have been read or modified, a Combine XYZ node is necessary to recompose the Vector.

Go to top - main - nodes - nodes menus

length_equal#

def length_equal(self, b=None, epsilon=None)

Args:#

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

  • epsilon: Float

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

length_greater_equal#

def length_greater_equal(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

length_greater_than#

def length_greater_than(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

length_less_equal#

def length_less_equal(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

length_less_than#

def length_less_than(self, b=None)

Args:#

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

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

length_not_equal#

def length_not_equal(self, b=None, epsilon=None)

Args:#

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

  • epsilon: Float

Returns:#

  • socket result

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

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 vector

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)

Args:#

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

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

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

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

  • clamp (bool): True

Returns:#

  • socket vector

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)

Args:#

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

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

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

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

  • clamp (bool): True

Returns:#

  • socket vector

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)

Args:#

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

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

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

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

  • clamp (bool): True

Returns:#

  • socket vector

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)

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 vector

Go to top - main - nodes - nodes menus

max#

def max(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

maximum#

def maximum(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

min#

def min(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

minimum#

def minimum(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

mix#

def mix(self, factor=None, vector=None, clamp_factor=True, factor_mode='UNIFORM')

Args:#

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

  • vector: [‘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

mix_non_uniform#

def mix_non_uniform(self, factor=None, vector=None, clamp_factor=True)

Args:#

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

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

  • clamp_factor (bool): True

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

mix_uniform#

def mix_uniform(self, vector=None, clamp_factor=True)

Args:#

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

  • clamp_factor (bool): True

Returns:#

  • socket result

Go to top - main - nodes - nodes menus

modulo#

def modulo(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

mul#

def mul(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

mul_add#

def mul_add(self, multiplier=None, addend=None)

Args:#

  • multiplier: Vector

  • addend: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

multiply#

def multiply(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

multiply_add#

def multiply_add(self, multiplier=None, addend=None)

Args:#

  • multiplier: Vector

  • addend: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

normalize#

def normalize(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

project#

def project(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

reflect#

def reflect(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

refract#

def refract(self, vector=None, ior=None)

Args:#

  • vector: Vector

  • ior: Float

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

rotate_axis_angle#

def rotate_axis_angle(self, center=None, axis=None, angle=None, invert=False)

Args:#

  • center: Vector

  • axis: Vector

  • angle: Float

  • invert (bool): False

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

rotate_euler#

def rotate_euler(self, center=None, rotation=None, invert=False)

Args:#

  • center: Vector

  • rotation: Vector

  • invert (bool): False

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

rotate_x#

def rotate_x(self, center=None, angle=None, invert=False)

Args:#

  • center: Vector

  • angle: Float

  • invert (bool): False

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

rotate_y#

def rotate_y(self, center=None, angle=None, invert=False)

Args:#

  • center: Vector

  • angle: Float

  • invert (bool): False

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

rotate_z#

def rotate_z(self, center=None, angle=None, invert=False)

Args:#

  • center: Vector

  • angle: Float

  • invert (bool): False

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

scale#

def scale(self, scale=None)

Args:#

  • scale: Float

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

sin#

def sin(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

sine#

def sine(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

snap#

def snap(self, increment=None)

Args:#

  • increment: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

sub#

def sub(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

subtract#

def subtract(self, vector=None)

Args:#

  • vector: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

switch#

def switch(self, switch=None, true=None)

Args:#

  • switch: Boolean

  • true: Vector

Returns:#

  • socket output

Go to top - main - nodes - nodes menus

tan#

def tan(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

tangent#

def tangent(self)

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus

wrap#

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

Args:#

  • max: Vector

  • min: Vector

Returns:#

  • socket vector

Go to top - main - nodes - nodes menus