unreal.PCGCreatePointsSphereSettings

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

Bases: PCGSettings

Generate a grid of points along the surface of a sphere.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGCreatePointsSphere.h

Editor Properties: (see get_editor_property/set_editor_property)

  • break_debugger (bool): [Read-Write] If a debugger is attached, a breakpoint will be triggered in the execution code to enable debugging. Only applies when inspecting a debug object. Transient and Editor-only.

  • category (Text): [Read-Write]

  • coordinate_space (PCGCoordinateSpace): [Read-Write] Sets the generation referential of the points.

  • cull_points_outside_volume (bool): [Read-Write] Points are removed if they are outside the volume.

  • debug (bool): [Read-Write]

  • debug_buffer_size (int32): [Read-Write] Size (in number of floats) of the shader debug print buffer.

  • debug_settings (PCGDebugVisualizationSettings): [Read-Write]

  • description (Text): [Read-Write]

  • determinism_settings (PCGDeterminismSettings): [Read-Write]

  • dump_cooked_hlsl (bool): [Read-Write] Dump the cooked HLSL into the log after it is generated.

  • dump_data_descriptions (bool): [Read-Write] Dump the data descriptions of input/output pins to the log.

  • enabled (bool): [Read-Write]

  • execute_on_gpu (bool): [Read-Write] Whether this node should be executed on the GPU.

  • execution_dependency_required (bool): [Read-Write] If enabled, the execution dependency pin will require to be connected for execution (as any other required pin) and will be used for culling.

  • expose_to_library (bool): [Read-Write]

  • geodesic_subdivisions (int32): [Read-Write] Determines the number of subdivisions of the geodesic sphere. Becomes exponentially more expensive as it gets higher.

  • jitter (double): [Read-Write] Adds randomization (in the range of [-Jitter, Jitter]) of the angles of a generated point.

  • latitudinal_end_angle (double): [Read-Write] Points will cease to be generated on the sphere’s surface after this equatorial angle.

  • latitudinal_segments (int32): [Read-Write] Will determine the latitudinal angle between segments needed to generate this number of latitudinal segments.

  • latitudinal_start_angle (double): [Read-Write] Points will be generated on the sphere’s surface beginning at this equatorial angle.

  • longitudinal_end_angle (double): [Read-Write] Points will cease to be generated on the sphere’s surface after this meridional angle.

  • longitudinal_segments (int32): [Read-Write] Will determine the longitudinal angle between segments needed to generate this number of longitudinal segments.

  • longitudinal_start_angle (double): [Read-Write] Points will be generated on the sphere’s surface beginning at this meridional angle.

  • origin (Vector): [Read-Write] The sphere’s origin, around which the points will be generated.

  • phi (double): [Read-Write] The longitudinal angle (in degrees) between generated segments on the standard sphere grid.

  • point_limit (int32): [Read-Write] Adds a graph error and prevents generation if the generated point count would exceed this amount.

  • point_orientation (PCGSpherePointOrientation): [Read-Write] Will determine the points’ orientation, once generated.

  • point_steepness (float): [Read-Write] Directly set as the output points’ steepness value.

  • poisson_distance (double): [Read-Write] The maximum world distance between points sampled on the sphere’s surface during a Poisson sampling, in cm.

  • poisson_max_attempts (int32): [Read-Write] Poisson sampling will continue to search for open positions until this limit is reached.

  • print_shader_debug_values (bool): [Read-Write] Enable use of ‘WriteDebugValue(uint Index, float Value)’ function in your kernel. Allows you to write float values to a buffer for logging on the CPU.

  • profile_kernel_index (int32): [Read-Write] Index of kernel emitted by this node to repeatedly dispatch every frame to enable profiling. Set to -1 to disable profiling. PCG_GPU_KERNEL_PROFILING must be defined in PCG.Build.cs.

  • radius (double): [Read-Write] The sphere’s radius.

  • sample_count (int32): [Read-Write] Determines the number of samples generated for the random generation and the poisson sampling.

  • seed (int32): [Read-Write]

  • sphere_generation (PCGSphereGeneration): [Read-Write] Determines the type of sphere generated.

  • theta (double): [Read-Write] The latitudinal angle (in degrees) between generated segments on the standard sphere grid.

  • trigger_render_capture (bool): [Read-Write] Will trigger a render capture when this node executes and a debug object is selected in the graph editor. Transient and Editor-only. Render captures must be enabled (e.g. -AttachRenderDoc or -AttachPIX).

  • use_seed (bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.

property coordinate_space: PCGCoordinateSpace

[Read-Write] Sets the generation referential of the points.

Type:

(PCGCoordinateSpace)

property cull_points_outside_volume: bool

[Read-Write] Points are removed if they are outside the volume.

Type:

(bool)

property geodesic_subdivisions: int

[Read-Write] Determines the number of subdivisions of the geodesic sphere. Becomes exponentially more expensive as it gets higher.

Type:

(int32)

property jitter: float

[Read-Write] Adds randomization (in the range of [-Jitter, Jitter]) of the angles of a generated point.

Type:

(double)

property latitudinal_end_angle: float

[Read-Write] Points will cease to be generated on the sphere’s surface after this equatorial angle.

Type:

(double)

property latitudinal_segments: int

[Read-Write] Will determine the latitudinal angle between segments needed to generate this number of latitudinal segments.

Type:

(int32)

property latitudinal_start_angle: float

[Read-Write] Points will be generated on the sphere’s surface beginning at this equatorial angle.

Type:

(double)

property longitudinal_end_angle: float

[Read-Write] Points will cease to be generated on the sphere’s surface after this meridional angle.

Type:

(double)

property longitudinal_segments: int

[Read-Write] Will determine the longitudinal angle between segments needed to generate this number of longitudinal segments.

Type:

(int32)

property longitudinal_start_angle: float

[Read-Write] Points will be generated on the sphere’s surface beginning at this meridional angle.

Type:

(double)

property origin: Vector

[Read-Write] The sphere’s origin, around which the points will be generated.

Type:

(Vector)

property phi: float

[Read-Write] The longitudinal angle (in degrees) between generated segments on the standard sphere grid.

Type:

(double)

property point_limit: int

[Read-Write] Adds a graph error and prevents generation if the generated point count would exceed this amount.

Type:

(int32)

property point_orientation: PCGSpherePointOrientation

[Read-Write] Will determine the points’ orientation, once generated.

Type:

(PCGSpherePointOrientation)

property point_steepness: float

[Read-Write] Directly set as the output points’ steepness value.

Type:

(float)

property poisson_distance: float

[Read-Write] The maximum world distance between points sampled on the sphere’s surface during a Poisson sampling, in cm.

Type:

(double)

property poisson_max_attempts: int

[Read-Write] Poisson sampling will continue to search for open positions until this limit is reached.

Type:

(int32)

property radius: float

[Read-Write] The sphere’s radius.

Type:

(double)

property sample_count: int

[Read-Write] Determines the number of samples generated for the random generation and the poisson sampling.

Type:

(int32)

property sphere_generation: PCGSphereGeneration

[Read-Write] Determines the type of sphere generated.

Type:

(PCGSphereGeneration)

property theta: float

[Read-Write] The latitudinal angle (in degrees) between generated segments on the standard sphere grid.

Type:

(double)