1. Epic GamesDeveloper
  3. UPCGCreatePointsSphereSettings

UPCGCreatePointsSphereSettings

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

API > API/Plugins > API/Plugins/PCG

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

   
Name UPCGCreatePointsSphereSettings
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGCreatePointsSphere.h
Include Path #include "Elements/PCGCreatePointsSphere.h"

Syntax

UCLASS (BlueprintType, ClassGroup=(Procedural))  
class UPCGCreatePointsSphereSettings : public UPCGSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGCreatePointsSphereSettings()

   Elements/PCGCreatePointsSphere.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCullPointsOutsideVolume bool Points are removed if they are outside the volume. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
CoordinateSpace EPCGCoordinateSpace Sets the generation referential of the points. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
GeodesicSubdivisions int32 Determines the number of subdivisions of the geodesic sphere. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="SphereGeneration == EPCGSphereGeneration::Geodesic", EditConditionHides, ClampMin=0, ClampMax=8)
Jitter double Adds randomization (in the range of [-Jitter, Jitter]) of the angles of a generated point. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="SphereGeneration == EPCGSphereGeneration::Angle || SphereGeneration == EPCGSphereGeneration::Segments", EditConditionHides, ClampMin=0.0, ClampMax=0.5)
LatitudinalEndAngle double Points will cease to be generated on the sphere's surface after this equatorial angle. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, ClampMin=90, ClampMax=90)
LatitudinalSegments int32 Will determine the latitudinal angle between segments needed to generate this number of latitudinal segments. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="SphereGeneration == EPCGSphereGeneration::Segments", EditConditionHides, ClampMin=1, ClampMax=90000)
LatitudinalStartAngle double Points will be generated on the sphere's surface beginning at this equatorial angle. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, ClampMin=90, ClampMax=90)
LongitudinalEndAngle double Points will cease to be generated on the sphere's surface after this meridional angle. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, ClampMin=180, ClampMax=180)
LongitudinalSegments int32 Will determine the longitudinal angle between segments needed to generate this number of longitudinal segments. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="SphereGeneration == EPCGSphereGeneration::Segments", EditConditionHides, ClampMin=1, ClampMax=180000)
LongitudinalStartAngle double Points will be generated on the sphere's surface beginning at this meridional angle. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, ClampMin=180, ClampMax=180)
Origin FVector The sphere's origin, around which the points will be generated. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
Phi double The longitudinal angle (in degrees) between generated segments on the standard sphere grid. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • DisplayName="Longitudinal Segment (Degrees)"
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="SphereGeneration == EPCGSphereGeneration::Angle", EditConditionHides, ClampMin=0.001, ClampMax=180)
PointLimit int32 Adds a graph error and prevents generation if the generated point count would exceed this amount. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • AdvancedDisplay
  • Meta=(ClampMin=1)
PointOrientation EPCGSpherePointOrientation Will determine the points' orientation, once generated. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
PointSteepness float Directly set as the output points' steepness value. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(ClampMin="0", ClampMax="1", PCG_Overridable)
PoissonDistance double The maximum world distance between points sampled on the sphere's surface during a Poisson sampling, in cm. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="SphereGeneration == EPCGSphereGeneration::Poisson", EditConditionHides, ClampMin=1)
PoissonMaxAttempts int32 Poisson sampling will continue to search for open positions until this limit is reached. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="SphereGeneration == EPCGSphereGeneration::Poisson", EditConditionHides, ClampMin=1)
Radius double The sphere's radius. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
SampleCount int32 Determines the number of samples generated for the random generation and the poisson sampling. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="SphereGeneration == EPCGSphereGeneration::Random || SphereGeneration == EPCGSphereGeneration::Poisson", EditConditionHides, ClampMin=1)
SphereGeneration EPCGSphereGeneration Determines the type of sphere generated. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Settings
  • Meta=(PCG_Overridable)
Theta double The latitudinal angle (in degrees) between generated segments on the standard sphere grid. Elements/PCGCreatePointsSphere.h
  • BlueprintReadWrite
  • EditAnywhere
  • DisplayName="Latitudinal Segment (Degrees)"
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="SphereGeneration == EPCGSphereGeneration::Angle", EditConditionHides, ClampMin=0.001, ClampMax=90)

Functions

Public

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual FName GetDefaultNodeName()

   Elements/PCGCreatePointsSphere.h  

virtual FText GetDefaultNodeTitle()

   Elements/PCGCreatePointsSphere.h  

virtual FText GetNodeTooltipText()

   Elements/PCGCreatePointsSphere.h  

virtual EPCGSettingsType GetType()

   Elements/PCGCreatePointsSphere.h  

virtual bool UseSeed ()

 By default, settings do not use a seed. Elements/PCGCreatePointsSphere.h  

Protected

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual FPCGElementPtr CreateElement()

   Elements/PCGCreatePointsSphere.h  

virtual TArray< FPCGPinProperties > InputPinProperties()

 Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins. Elements/PCGCreatePointsSphere.h  

virtual TArray< FPCGPinProperties > OutputPinProperties()

   Elements/PCGCreatePointsSphere.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page