unreal.PCGPoint

class unreal.PCGPoint(transform: Transform = Ellipsis, density: float = 0.0, bounds_min: Vector = Ellipsis, bounds_max: Vector = Ellipsis, color: Vector4 = Ellipsis, steepness: float = 0.0, seed: int = 0, metadata_entry: int = 0)

Bases: StructBase

C++ Source:

• Plugin: PCG

• Module: PCG

• File: PCGPoint.h

Editor Properties: (see get_editor_property/set_editor_property)

• bounds_max (Vector): [Read-Write]

• bounds_min (Vector): [Read-Write]

• color (Vector4): [Read-Write]

• density (float): [Read-Write]

• metadata_entry (int64): [Read-Only]

• seed (int32): [Read-Write]

• steepness (float): [Read-Write]

• transform (Transform): [Read-Write]

property bounds_max: Vector

[Read-Write]

Type:

(Vector)

property bounds_min: Vector

[Read-Write]

Type:

(Vector)

property color: Vector4

[Read-Write]

Type:

(Vector4)

copy_point(copy_metadata=True, metadata=None, out_metadata=None) → PCGPoint

Point functions

Parameters:

• copy_metadata (bool) –

• metadata (PCGMetadata) –

• out_metadata (PCGMetadata) –

Returns:

out_point (PCGPoint):

Return type:

PCGPoint

property density: float

[Read-Write]

Type:

(float)

get_bool_attribute(metadata, attribute_name) → bool

Get Bool Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

bool

get_double_attribute(metadata, attribute_name) → double

Get Double Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

double

get_extents() → Vector

Get Extents

Return type:

Vector

get_float_attribute(metadata, attribute_name) → float

Get Float Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

float

get_integer32_attribute(metadata, attribute_name) → int32

Get Integer 32Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

int32

get_integer64_attribute(metadata, attribute_name) → int64

Get Integer 64Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

int64

get_local_center() → Vector

Get Local Center

Return type:

Vector

get_name_attribute(metadata, attribute_name) → Name

Get Name Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

Name

get_quat_attribute(metadata, attribute_name) → Quat

Get Quat Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

Quat

get_random_stream(optional_settings: PCGSettings = Ellipsis, optional_component: PCGComponent = Ellipsis) → RandomStream

deprecated: ‘get_random_stream’ was renamed to ‘get_random_stream_from_point’.

get_random_stream_from_point(optional_settings=None, optional_component=None) → RandomStream

Creates a random stream from a point’s seed and settings/component’s seed (optional)

Parameters:

• optional_settings (PCGSettings) –

• optional_component (PCGComponent) –

Return type:

RandomStream

get_random_stream_from_two_points(point_b, optional_settings=None, optional_component=None) → RandomStream

Creates a random stream from using the random seeds from two points, as well as settings/component’s seed (optional)

Parameters:

• point_b (PCGPoint) –

• optional_settings (PCGSettings) –

• optional_component (PCGComponent) –

Return type:

RandomStream

get_rotator_attribute(metadata, attribute_name) → Rotator

Get Rotator Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

Rotator

get_soft_class_path_attribute(metadata, attribute_name) → SoftClassPath

Get Soft Class Path Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

SoftClassPath

get_soft_object_path_attribute(metadata, attribute_name) → SoftObjectPath

Get Soft Object Path Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

SoftObjectPath

get_string_attribute(metadata, attribute_name) → str

Get String Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

str

get_transform_attribute(metadata, attribute_name) → Transform

Get Transform Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

Transform

get_transformed_bounds() → Box

Get Transformed Bounds

Return type:

Box

get_vector2_attribute(metadata, attribute_name) → Vector2D

Get Vector 2Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

Vector2D

get_vector4_attribute(metadata, attribute_name) → Vector4

Get Vector 4Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

Vector4

get_vector_attribute(metadata, attribute_name) → Vector

Get Vector Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

Vector

has_attribute_set(metadata, attribute_name) → bool

Has Attribute Set

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

Return type:

bool

initialize_metadata(metadata, parent_point, parent_metadata=None) → None

Assigns a metadata entry key and will copy attribute values if from an unrelated metadata. Note: a null ParentMetadata assumes this is the same as Metadata

Parameters:

• metadata (PCGMetadata) –

• parent_point (PCGPoint) –

• parent_metadata (PCGMetadata) –

property metadata_entry: int

[Read-Only]

Type:

(int64)

property seed: int

[Read-Write]

Type:

(int32)

set_bool_attribute(metadata, attribute_name, value) → None

Set Bool Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (bool) –

set_double_attribute(metadata, attribute_name, value) → None

Set Double Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (double) –

set_extents(extents) → None

Set Extents

Parameters:

extents (Vector) –

set_float_attribute(metadata, attribute_name, value) → None

Set Float Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (float) –

set_integer32_attribute(metadata, attribute_name, value) → None

Set Integer 32Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (int32) –

set_integer64_attribute(metadata, attribute_name, value) → None

Set Integer 64Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (int64) –

set_local_center(local_center) → None

Set Local Center

Parameters:

local_center (Vector) –

set_name_attribute(metadata, attribute_name, value) → None

Set Name Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (Name) –

set_quat_attribute(metadata, attribute_name, value) → None

Set Quat Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (Quat) –

set_rotator_attribute(metadata, attribute_name, value) → None

Set Rotator Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (Rotator) –

set_soft_class_path_attribute(metadata, attribute_name, value) → None

Set Soft Class Path Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (SoftClassPath) –

set_soft_object_path_attribute(metadata, attribute_name, value) → None

Set Soft Object Path Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (SoftObjectPath) –

set_string_attribute(metadata, attribute_name, value) → None

Set String Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (str) –

set_transform_attribute(metadata, attribute_name, value) → None

Set Transform Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (Transform) –

set_vector2_attribute(metadata, attribute_name, value) → None

Set Vector 2Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (Vector2D) –

set_vector4_attribute(metadata, attribute_name, value) → None

Set Vector 4Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (Vector4) –

set_vector_attribute(metadata, attribute_name, value) → None

Set Vector Attribute

Parameters:

• metadata (PCGMetadata) –

• attribute_name (Name) –

• value (Vector) –

property steepness: float

[Read-Write]

Type:

(float)

property transform: Transform

[Read-Write]

Type:

(Transform)