unreal.GeometryScriptScalarList

class unreal.GeometryScriptScalarList

Bases: StructBase

Geometry Script Scalar List

C++ Source:

  • Plugin: GeometryScripting

  • Module: GeometryScriptingCore

  • File: GeometryScriptTypes.h

clear_scalar_list(clear_value=0.000000) → None

Clear Scalar List

Parameters:

clear_value (double) –

convert_scalar_list_to_array() → Array[double]

Convert Scalar List to Array

Returns:

scalar_array (Array[double]):

Return type:

Array[double]

duplicate_scalar_list() → GeometryScriptScalarList

Duplicate Scalar List

Returns:

duplicate_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

get_scalar_list_item(index) -> (double, is_valid_index=bool)

Get Scalar List Item

Parameters:

index (int32) –

Returns:

is_valid_index (bool):

Return type:

bool

get_scalar_list_last_index() → int32

Get Scalar List Last Index

Return type:

int32

get_scalar_list_length() → int32

Get Scalar List Length

Return type:

int32

scalar_blend(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:
Return type:

GeometryScriptScalarList

scalar_blend_in_place(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:
Returns:

scalar_list_b (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

scalar_invert(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:

  • numerator (double) –

  • set_on_failure (double) –

  • epsilon (double) –

Return type:

GeometryScriptScalarList

scalar_invert_in_place(numerator=1.000000, set_on_failure=0.000000, epsilon=0.000000) → None

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

Parameters:

  • numerator (double) –

  • set_on_failure (double) –

  • epsilon (double) –

scalar_multiply(scalar_list_b, constant_multiplier=1.000000) → GeometryScriptScalarList

Scalar Multiply

Parameters:
Return type:

GeometryScriptScalarList

scalar_multiply_in_place(scalar_list_b, constant_multiplier=1.000000) → GeometryScriptScalarList

Scalar Multiply in Place

Parameters:
Returns:

scalar_list_b (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

scalar_vector_multiply(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:
Return type:

GeometryScriptVectorList

scalar_vector_multiply_in_place(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:
Returns:

vector_list (GeometryScriptVectorList):

Return type:

GeometryScriptVectorList

set_scalar_list_item(index, new_value) → bool

Set Scalar List Item

Parameters:

  • index (int32) –

  • new_value (double) –

Returns:

is_valid_index (bool):

Return type:

bool