unreal.GeometryScript_VectorMath

class unreal.GeometryScript_VectorMath(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: BlueprintFunctionLibrary

Geometry Script Library Vector Math Functions

C++ Source:

• Plugin: GeometryScripting

• Module: GeometryScriptingCore

• File: VectorMathFunctions.h

classmethod constant_scalar_multiply(constant, scalar_list) → GeometryScriptScalarList

Constant Scalar Multiply

Parameters:

• constant (double) –

• scalar_list (GeometryScriptScalarList) –

Return type:

GeometryScriptScalarList

classmethod constant_scalar_multiply_in_place(constant, scalar_list) → GeometryScriptScalarList

Constant Scalar Multiply in Place

Parameters:

• constant (double) –

• scalar_list (GeometryScriptScalarList) –

Returns:

scalar_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod constant_vector_multiply(constant, vector_list) → GeometryScriptVectorList

Compute (Constant * Vector) for each element in VectorList, and return in a new list

Parameters:

• constant (double) –

• vector_list (GeometryScriptVectorList) –

Return type:

GeometryScriptVectorList

classmethod constant_vector_multiply_in_place(constant, vector_list) → GeometryScriptVectorList

Compute (Constant * Vector) for each element in VectorList, and store in VectorList

Parameters:

• constant (double) –

• vector_list (GeometryScriptVectorList) –

Returns:

vector_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

classmethod scalar_blend(scalar_list_a, scalar_list_b, constant_a=1.000000, constant_b=1.000000) → GeometryScriptScalarList

Compute (ConstantA * A) + (ConstantB * B) for each pair of values in ScalarListA and ScalarListB and return in new ScalarList. By default (constants = 1) this just adds the two values. Set ConstantB = -1 to subtract B from A. Can also be used to Linear Interpolate, by setting ConstantB = (1-ConstantA)

Parameters:

• scalar_list_a (GeometryScriptScalarList) –

• scalar_list_b (GeometryScriptScalarList) –

• constant_a (double) –

• constant_b (double) –

Return type:

GeometryScriptScalarList

classmethod scalar_blend_in_place(scalar_list_a, scalar_list_b, constant_a=1.000000, constant_b=1.000000) → GeometryScriptScalarList

Compute (ConstantA * A) + (ConstantB * B) for each pair of values in ScalarListA and ScalarListB and return in ScalarListB. By default (constants = 1) this just adds the two values. Set ConstantB = -1 to subtract B from A. Can also be used to Linear Interpolate, by setting ConstantB = (1-ConstantA)

Parameters:

• scalar_list_a (GeometryScriptScalarList) –

• scalar_list_b (GeometryScriptScalarList) –

• constant_a (double) –

• constant_b (double) –

Returns:

scalar_list_b (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod scalar_invert(scalar_list, numerator=1.000000, set_on_failure=0.000000, epsilon=0.000000) → GeometryScriptScalarList

Compute (Numerator / Scalar) for each element of ScalarList and return in a new ScalarList. If Abs(Scalar) < Epsilon, set to SetOnFailure value.

Parameters:

• scalar_list (GeometryScriptScalarList) –

• numerator (double) –

• set_on_failure (double) –

• epsilon (double) –

Return type:

GeometryScriptScalarList

classmethod scalar_invert_in_place(scalar_list, numerator=1.000000, set_on_failure=0.000000, epsilon=0.000000) → GeometryScriptScalarList

Compute (Numerator / Scalar) for each element of ScalarList and store in input ScalarList If Abs(Scalar) < Epsilon, set to SetOnFailure value.

Parameters:

• scalar_list (GeometryScriptScalarList) –

• numerator (double) –

• set_on_failure (double) –

• epsilon (double) –

Returns:

scalar_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod scalar_multiply(scalar_list_a, scalar_list_b, constant_multiplier=1.000000) → GeometryScriptScalarList

Scalar Multiply

Parameters:

• scalar_list_a (GeometryScriptScalarList) –

• scalar_list_b (GeometryScriptScalarList) –

• constant_multiplier (double) –

Return type:

GeometryScriptScalarList

classmethod scalar_multiply_in_place(scalar_list_a, scalar_list_b, constant_multiplier=1.000000) → GeometryScriptScalarList

Scalar Multiply in Place

Parameters:

• scalar_list_a (GeometryScriptScalarList) –

• scalar_list_b (GeometryScriptScalarList) –

• constant_multiplier (double) –

Returns:

scalar_list_b (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

classmethod scalar_vector_multiply(scalar_list, vector_list, scalar_multiplier=1.000000) → GeometryScriptVectorList

Compute (ScalarMultiplier * Scalar * Vector) for each scalar/vector pair in the two input lists, and return in a new VectorList.

Parameters:

• scalar_list (GeometryScriptScalarList) –

• vector_list (GeometryScriptVectorList) –

• scalar_multiplier (double) –

Return type:

GeometryScriptVectorList

classmethod scalar_vector_multiply_in_place(scalar_list, vector_list, scalar_multiplier=1.000000) → GeometryScriptVectorList

Compute (ScalarMultiplier * Scalar * Vector) for each scalar/vector pair in the two input lists, and store in the input VectorList

Parameters:

• scalar_list (GeometryScriptScalarList) –

• vector_list (GeometryScriptVectorList) –

• scalar_multiplier (double) –

Returns:

vector_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

classmethod vector_blend(vector_list_a, vector_list_b, constant_a=1.000000, constant_b=1.000000) → GeometryScriptVectorList

Compute (ConstantA * A) + (ConstantB * B) for each pair of vectors in VectorListA and VectorListB and return in new VectorList. By default (constants = 1) this just adds the two vectors. Set ConstantB = -1 to subtract B from A. Can also be used to Linear Interpolate, by setting ConstantB = (1-ConstantA)

Parameters:

• vector_list_a (GeometryScriptVectorList) –

• vector_list_b (GeometryScriptVectorList) –

• constant_a (double) –

• constant_b (double) –

Return type:

GeometryScriptVectorList

classmethod vector_blend_in_place(vector_list_a, vector_list_b, constant_a=1.000000, constant_b=1.000000) → GeometryScriptVectorList

Compute (ConstantA * A) + (ConstantB * B) for each pair of vectors in VectorListA and VectorListB, and store in VectorListB By default (constants = 1) this just adds the two vectors. Set ConstantB = -1 to subtract B from A. Can also be used to Linear Interpolate, by setting ConstantB = (1-ConstantA)

Parameters:

• vector_list_a (GeometryScriptVectorList) –

• vector_list_b (GeometryScriptVectorList) –

• constant_a (double) –

• constant_b (double) –

Returns:

vector_list_b (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

classmethod vector_cross(vector_list_a, vector_list_b) → GeometryScriptVectorList

Compute the cross-product between each pair of vectors in VectorListA and VectorListB and return in new VectorList

Parameters:

• vector_list_a (GeometryScriptVectorList) –

• vector_list_b (GeometryScriptVectorList) –

Return type:

GeometryScriptVectorList

classmethod vector_dot(vector_list_a, vector_list_b) → GeometryScriptScalarList

Compute the dot-product between each pair of vectors in VectorListA and VectorListB and return in new ScalarList

Parameters:

• vector_list_a (GeometryScriptVectorList) –

• vector_list_b (GeometryScriptVectorList) –

Return type:

GeometryScriptScalarList

classmethod vector_length(vector_list) → GeometryScriptScalarList

Compute the length/magnitude of each vector in VectorListA and return in new ScalarList. Note that SquaredLength can be computed using VectorDot(A,A).

Parameters:

vector_list (GeometryScriptVectorList) –

Return type:

GeometryScriptScalarList

classmethod vector_normalize_in_place(vector_list, set_on_failure=[0.000000, 0.000000, 0.000000]) → GeometryScriptVectorList

Normalize each vector in VectorList, and store in VectorList. If a vector is degenerate, set the normal to the SetOnFailure vector.

Parameters:

• vector_list (GeometryScriptVectorList) –

• set_on_failure (Vector) –

Returns:

vector_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

classmethod vector_to_scalar(vector_list, constant_x=1.000000, constant_y=0.000000, constant_z=0.000000) → GeometryScriptScalarList

Convert each Vector in VectorList to a Scalar by computing (ConstantX*Vector.X + ConstantY*Vector.Y + ConstantZ*Vector.Z), and return in a new ScalarList. This can be used to extract the X/Y/Z values from a Vector, or other component-wise math

Parameters:

• vector_list (GeometryScriptVectorList) –

• constant_x (double) –

• constant_y (double) –

• constant_z (double) –

Return type:

GeometryScriptScalarList