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

Resets all the items in the Scalar List to the Clear Value.

Parameters:

clear_value (double) –

convert_scalar_list_to_array() → Array[double]

Converts a Scalar List to an Scalar Array (an array of doubles).

Returns:

scalar_array (Array[double]):

Return type:

Array[double]

duplicate_scalar_list() → GeometryScriptScalarList

Copies the contents of Scalar List into Duplicate List.

Returns:

duplicate_list (GeometryScriptScalarList):

Return type:

GeometryScriptScalarList

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

Returns the Scalar value associated with Index in Scalar List. If the Index is not valid for this Scalar List, the value 0.0 will be returned and bIsValidIndex set to false.

Parameters:

index (int32) –

Returns:

is_valid_index (bool):

Return type:

bool

get_scalar_list_last_index() → int32

Returns the index of the last Scalar in Scalar List. If Scalar List is empty or invalid, the value -1 will be returned

Return type:

int32

get_scalar_list_length() → int32

Returns the number of items in the Scalar List.

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

Returns a Scalar List constructed with each element is the product (ConstantMultiplier * A * B) where A and B are the corresponding elements from ScalarListA and ScalarListB accordingly. If ScalarListA and ScalarListB have different lengths, no operation will be performed and an empty Scalar List will be returned.

Parameters:
Return type:

GeometryScriptScalarList

scalar_multiply_in_place(scalar_list_b, constant_multiplier=1.000000) → GeometryScriptScalarList

Compute (ConstantMultiplier * A * B) where A and B are the corresponding elements from ScalarListA and ScalarListB accordingly, and store the result in ScalarListA. If ScalarListA and ScalarListB have different lengths, the computation will be skipped.

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

Updates the value associated with Index in the Scalar List. If the Index is invalid, the operation will fail and bValidIndex will be set to false.

Parameters:

  • index (int32) –

  • new_value (double) –

Returns:

is_valid_index (bool):

Return type:

bool