unreal.PCGBasePointData

class unreal.PCGBasePointData(outer: Object | None = None, name: Name | str = 'None')

Bases: PCGSpatialData

PCGBase Point Data

C++ Source:

• Plugin: PCG

• Module: PCG

• File: PCGBasePointData.h

Editor Properties: (see get_editor_property/set_editor_property)

• keep_zero_density_points (bool): [Read-Write]

• target_actor (Actor): [Read-Write] Recipient of any artifacts generated using this data.

bp_allocate_properties(properties) → None

BP Allocate Properties

Parameters:

properties (int32)

bp_copy_points_from(data: PCGBasePointData, data_indices: None) → None

deprecated: ‘bp_copy_points_from’ was renamed to ‘bp_set_points_from’.

bp_set_points_from(data, data_indices) → None

BP Set Points From

Parameters:

• data (PCGBasePointData)

• data_indices (Array[int32])

copy_points_from(data: PCGBasePointData, data_indices: None) → None

deprecated: ‘copy_points_from’ was renamed to ‘bp_set_points_from’.

get_bounds_max(point_index) → Vector

Get Bounds Max

Parameters:

point_index (int32)

Return type:

Vector

classmethod get_bounds_max_values_from_range(input_range) → Array[Vector]

Get Bounds Max Values from Range

Parameters:

input_range (PCGPointInputRange)

Return type:

Array[Vector]

get_bounds_min(point_index) → Vector

Get Bounds Min

Parameters:

point_index (int32)

Return type:

Vector

classmethod get_bounds_min_values_from_range(input_range) → Array[Vector]

Get Bounds Min Values from Range

Parameters:

input_range (PCGPointInputRange)

Return type:

Array[Vector]

get_color(point_index) → Vector4

Get Color

Parameters:

point_index (int32)

Return type:

Vector4

classmethod get_color_values_from_range(input_range) → Array[Vector4]

Get Color Values from Range

Parameters:

input_range (PCGPointInputRange)

Return type:

Array[Vector4]

get_density(point_index) → float

Get Density

Parameters:

point_index (int32)

Return type:

float

get_density_bounds(point_index) → BoxSphereBounds

Get Density Bounds

Parameters:

point_index (int32)

Return type:

BoxSphereBounds

classmethod get_density_values_from_range(input_range) → Array[float]

Get Density Values from Range

Parameters:

input_range (PCGPointInputRange)

Return type:

Array[float]

get_extents(point_index) → Vector

Get Extents

Parameters:

point_index (int32)

Return type:

Vector

get_local_bounds(point_index) → Box

Get Local Bounds

Parameters:

point_index (int32)

Return type:

Box

get_local_center(point_index) → Vector

Get Local Center

Parameters:

point_index (int32)

Return type:

Vector

get_local_density_bounds(point_index) → Box

Get Local Density Bounds

Parameters:

point_index (int32)

Return type:

Box

get_local_size(point_index) → Vector

Get Local Size

Parameters:

point_index (int32)

Return type:

Vector

get_metadata_entry(point_index) → int64

Get Metadata Entry

Parameters:

point_index (int32)

Return type:

int64

classmethod get_metadata_entry_values_from_range(input_range) → Array[int64]

Get Metadata Entry Values from Range

Parameters:

input_range (PCGPointInputRange)

Return type:

Array[int64]

get_num_points() → int32

Get Num Points

Return type:

int32

classmethod get_point_from_range(input_range, index) → PCGPoint

Get Point from Range

Parameters:

• input_range (PCGPointInputRange)

• index (int32)

Return type:

PCGPoint

get_scaled_extents(point_index) → Vector

Get Scaled Extents

Parameters:

point_index (int32)

Return type:

Vector

get_scaled_local_size(point_index) → Vector

Get Scaled Local Size

Parameters:

point_index (int32)

Return type:

Vector

get_seed(point_index) → int32

Get Seed

Parameters:

point_index (int32)

Return type:

int32

classmethod get_seed_values_from_range(input_range) → Array[int32]

Get Seed Values from Range

Parameters:

input_range (PCGPointInputRange)

Return type:

Array[int32]

get_steepness(point_index) → float

Get Steepness

Parameters:

point_index (int32)

Return type:

float

classmethod get_steepness_values_from_range(input_range) → Array[float]

Get Steepness Values from Range

Parameters:

input_range (PCGPointInputRange)

Return type:

Array[float]

get_transform(point_index) → Transform

Get Transform

Parameters:

point_index (int32)

Return type:

Transform

classmethod get_transform_values_from_range(input_range) → Array[Transform]

Get Transform Values from Range

Parameters:

input_range (PCGPointInputRange)

Return type:

Array[Transform]

is_empty() → bool

Is Empty

Return type:

bool

set_bounds_max(bounds_max) → None

Set all bounds max to same value

Parameters:

bounds_max (Vector)

classmethod set_bounds_max_values_on_range(output_range, values) → PCGPointOutputRange

Set Bounds Max Values on Range

Parameters:

• output_range (PCGPointOutputRange)

• values (Array[Vector])

Returns:

output_range (PCGPointOutputRange):

Return type:

PCGPointOutputRange

set_bounds_min(bounds_min) → None

Set all bounds min to same value

Parameters:

bounds_min (Vector)

classmethod set_bounds_min_values_on_range(output_range, values) → PCGPointOutputRange

Set Bounds Min Values on Range

Parameters:

• output_range (PCGPointOutputRange)

• values (Array[Vector])

Returns:

output_range (PCGPointOutputRange):

Return type:

PCGPointOutputRange

set_color(color) → None

Set all colors to same value

Parameters:

color (Vector4)

classmethod set_color_values_on_range(output_range, values) → PCGPointOutputRange

Set Color Values on Range

Parameters:

• output_range (PCGPointOutputRange)

• values (Array[Vector4])

Returns:

output_range (PCGPointOutputRange):

Return type:

PCGPointOutputRange

set_density(density) → None

Set all densities to same value

Parameters:

density (float)

classmethod set_density_values_on_range(output_range, values) → PCGPointOutputRange

Set Density Values on Range

Parameters:

• output_range (PCGPointOutputRange)

• values (Array[float])

Returns:

output_range (PCGPointOutputRange):

Return type:

PCGPointOutputRange

set_extents(extents) → None

Set all extents to same value

Parameters:

extents (Vector)

set_local_center(local_center) → None

Set all local centers to same value

Parameters:

local_center (Vector)

set_metadata_entry(metadata_entry) → None

Set all metadata entries to same value

Parameters:

metadata_entry (int64)

classmethod set_metadata_entry_values_on_range(output_range, values) → PCGPointOutputRange

Set Metadata Entry Values on Range

Parameters:

• output_range (PCGPointOutputRange)

• values (Array[int64])

Returns:

output_range (PCGPointOutputRange):

Return type:

PCGPointOutputRange

set_num_points(num_points, initialize_values=True) → None

Set Num Points

Parameters:

• num_points (int32)

• initialize_values (bool)

classmethod set_point_on_range(output_range, index, point) → PCGPointOutputRange

Set Point on Range

Parameters:

• output_range (PCGPointOutputRange)

• index (int32)

• point (PCGPoint)

Returns:

output_range (PCGPointOutputRange):

Return type:

PCGPointOutputRange

set_seed(seed) → None

Set all seeds to same value

Parameters:

seed (int32)

classmethod set_seed_values_on_range(output_range, values) → PCGPointOutputRange

Set Seed Values on Range

Parameters:

• output_range (PCGPointOutputRange)

• values (Array[int32])

Returns:

output_range (PCGPointOutputRange):

Return type:

PCGPointOutputRange

set_steepness(steepness) → None

Set all steepness to same value

Parameters:

steepness (float)

classmethod set_steepness_values_on_range(output_range, values) → PCGPointOutputRange

Set Steepness Values on Range

Parameters:

• output_range (PCGPointOutputRange)

• values (Array[float])

Returns:

output_range (PCGPointOutputRange):

Return type:

PCGPointOutputRange

set_transform(transform) → None

Set all transforms to same value

Parameters:

transform (Transform)

classmethod set_transform_values_on_range(output_range, values) → PCGPointOutputRange

Set Transform Values on Range

Parameters:

• output_range (PCGPointOutputRange)

• values (Array[Transform])

Returns:

output_range (PCGPointOutputRange):

Return type:

PCGPointOutputRange