1. Epic GamesDeveloper
  3. PlanarCut

PlanarCut

API > API/Plugins

   
Name PlanarCut
Type Plugin
Part of Plugins Planar Cut
Location /Engine/Plugins/Experimental/PlanarCutPlugin/Source/PlanarCut/
Module Build Rules PlanarCut.Build.cs

Structs

Name Remarks
FInternalSurfaceMaterials Auxiliary structure for FPlanarCells to carry material info
FMergeIslandSettings  
FNoiseOffsets Offsets to randomize where Perlin noise is sampled for each dimension of a noise vector.
FNoiseSettings  
FPlanarCells Stores planar facets that divide space into cells.
FTextureAttributeSettings  

Interfaces

Name Remarks
IPlanarCutPlugin The public interface to this module

Enums

Public

Name Remarks
UE::PlanarCut::EBakeAttributes Different attributes we can bake.
UE::PlanarCut::ENeighborSelectionMethod  
UE::PlanarCut::ETargetFaces  
UE::PlanarCut::EUseMaterials Note: prefer ETargetFaces below.

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddCollisionSampleVertices ( double TargetSpacing,
FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices
)

 Scatter additional vertices (w/ no associated triangle) as needed to satisfy minimum point spacing PlanarCut.h  

void ConvertGeometryCollectionToDynamicMesh ( UE::Geometry::FDynamicMesh3& OutputMesh,
FTransform& TransformOut,
bool bCenterPivot,
const FGeometryCollection& Collection,
bool bWeldEdges,
TArrayView< const FTransform3f > BoneTransforms,
bool bUseRelativeTransforms,
TArrayView< const int32 > TransformIndices,
TFunction< int32(int32, bool)> RemapMaterialIDs,
bool bAllowInvisible,
bool bSetPolygroupPerBone
)

 Convert chosen Geometry groups inside a GeometryCollection to a single Dynamic Mesh. PlanarCut.h  

UE::Geometry::FDynamicMesh3 ConvertMeshDescriptionToCuttingDynamicMesh ( const FMeshDescription* CuttingMesh,
int32 NumUVLayers,
FProgressCancel* Progress
)

 Convert a mesh description to a dynamic mesh specifically augmented / designed for cutting geometry collections, to be passed to CutWithMesh. PlanarCut.h  

void ConvertToMeshDescription ( FMeshDescription& OutputMesh,
FTransform& TransformOut,
bool bCenterPivot,
FGeometryCollection& Collection,
const TManagedArray< FTransform >& BoneTransforms,
const TArrayView< const int32 >& TransformIndices,
TFunction< int32(int32, bool)> RemapMaterialIDs
)

 Convert chosen Geometry groups inside a GeometryCollection to a single Mesh Description. PlanarCut.h  

void ConvertToMeshDescription ( FMeshDescription& OutputMesh,
FTransform& TransformOut,
bool bCenterPivot,
FGeometryCollection& Collection,
const TManagedArray< FTransform3f >& BoneTransforms,
const TArrayView< const int32 >& TransformIndices,
TFunction< int32(int32, bool)> RemapMaterialIDs
)

 Convert chosen Geometry groups inside a GeometryCollection to a single Mesh Description. PlanarCut.h  

void CreateCuttingSurfacePreview ( const FPlanarCells& Cells,
const FBox& Bounds,
double Grout,
int32 RandomSeed,
UE::Geometry::FDynamicMesh3& OutCuttingMeshes,
TFunctionRef< bool(int)> FilterCellsFunc,
const TOptional< FTransform >& TransformCollection,
FProgressCancel* Progress,
FVector CellsOrigin
)

 Generate cutting mesh surfaces as a single mesh Useful for creating a preview of the cut surface. PlanarCut.h  

int32 CutMultipleWithMultiplePlanes ( const TArrayView< const FPlane >& Planes,
FInternalSurfaceMaterials& InternalSurfaceMaterials,
FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
double Grout,
double CollisionSampleSpacing,
int32 RandomSeed,
const TOptional< FTransform >& TransformCollection,
bool bSetDefaultInternalMaterialsFromCollection,
FProgressCancel* Progress,
bool bSplitIslands
)

 Cut multiple Geometry groups inside a GeometryCollection with Planes, and add each cut cell back to the GeometryCollection as a new child of their source Geometry. PlanarCut.h  

int32 CutMultipleWithPlanarCells ( FPlanarCells& Cells,
FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
double Grout,
double CollisionSampleSpacing,
int32 RandomSeed,
const TOptional< FTransform >& TransformCollection,
bool bIncludeOutsideCellInOutput,
bool bSetDefaultInternalMaterialsFromCollection,
FProgressCancel* Progress,
FVector CellsOrigin,
bool bSplitIslands
)

 Cut multiple Geometry groups inside a GeometryCollection with PlanarCells, and add each cut cell back to the GeometryCollection as a new child of their source Geometry. PlanarCut.h  

int32 CutWithMesh ( const UE::Geometry::FDynamicMesh3& CuttingMesh,
FTransform CuttingMeshTransform,
FInternalSurfaceMaterials& InternalSurfaceMaterials,
FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
double CollisionSampleSpacing,
const TOptional< FTransform >& TransformCollection,
bool bSetDefaultInternalMaterialsFromCollection,
FProgressCancel* Progress,
bool bSplitIslands
)

 Cut multiple Geometry groups inside a GeometryCollection with a mesh, and add each cut cell back to the GeometryCollection as a new child of their source Geometry. PlanarCut.h  

int32 CutWithMesh ( const FMeshDescription* CuttingMesh,
FTransform CuttingMeshTransform,
FInternalSurfaceMaterials& InternalSurfaceMaterials,
FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
double CollisionSampleSpacing,
const TOptional< FTransform >& TransformCollection,
bool bSetDefaultInternalMaterialsFromCollection,
FProgressCancel* Progress,
bool bSplitIslands
)

   PlanarCut.h  

int32 CutWithPlanarCells ( FPlanarCells& Cells,
FGeometryCollection& Collection,
int32 TransformIdx,
double Grout,
double CollisionSampleSpacing,
int32 RandomSeed,
const TOptional< FTransform >& TransformCollection,
bool bIncludeOutsideCellInOutput,
bool bSetDefaultInternalMaterialsFromCollection,
FProgressCancel* Progress,
FVector CellsOrigin,
bool bSplitIslands
)

 Cut a Geometry inside a GeometryCollection with PlanarCells, and add each cut cell back to the GeometryCollection as a new child of the input Geometry. PlanarCut.h  

void FilterBonesByVolume ( const FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
const TArrayView< const double >& Volumes,
TFunctionRef< bool(double Volume, int32 BoneIdx)> Filter,
TArray< int32 >& OutSmallBones,
bool bIncludeClusters
)

 Populate an array of transform indices w/ those that match a custom volume-based filter PlanarCut.h  

void FindBoneVolumes ( FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
TArray< double >& OutVolumes,
double ScalePerDimension,
bool bIncludeClusters
)

 Populate an array of transform indices w/ those that are smaller than a threshold volume PlanarCut.h  

void FindSmallBones ( const FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
const TArrayView< const double >& Volumes,
double MinVolume,
TArray< int32 >& OutSmallBones,
bool bIncludeClusters
)

 Populate an array of transform indices w/ those that are smaller than a threshold volume PlanarCut.h  

void MergeAllSelectedBones ( FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
bool bUnionJoinedPieces
)

 Merge all chosen nodes into a single node. PlanarCut.h  

int32 MergeBones ( FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
const TArrayView< const double >& Volumes,
double MinVolume,
const TArrayView< const int32 >& SmallTransformIndices,
bool bUnionJoinedPieces,
UE::PlanarCut::ENeighborSelectionMethod NeighborSelectionMethod,
bool bUseCollectionProximity,
bool bOnlySameParent
)

 Merge chosen geometry into neighboring geometry. PlanarCut.h  

void MergeClusters ( FGeometryCollection& Collection,
const TArrayView< const double >& Volumes,
double MinVolume,
const TArrayView< const int32 >& SmallTransformIndices,
UE::PlanarCut::ENeighborSelectionMethod NeighborSelectionMethod,
bool bOnlyMergeInProximity,
bool bOnlySameParent,
bool bUseCollectionProximity
)

 Merge chosen bones into neighboring clusters. PlanarCut.h  

void RecomputeNormalsAndTangents ( bool bOnlyTangents,
bool bMakeSharpEdges,
float SharpAngleDegrees,
FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
bool bOnlyInternalSurfaces
)

 Recompute normals and tangents of selected geometry, optionally restricted to faces with odd or given material IDs (i.e. to target internal faces) PlanarCut.h  

int32 SplitIslands ( FGeometryCollection& Collection,
const TArrayView< const int32 >& TransformIndices,
double CollisionSampleSpacing,
FProgressCancel* Progress
)

 Split the geometry at the given transforms into their connected components PlanarCut.h  

bool UE::PlanarCut::BoxProjectUVs ( int32 TargetUVLayer,
FGeometryCollection& Collection,
const FVector3d& BoxDimensions,
EUseMaterials MaterialsPattern,
TArrayView< int32 > WhichMaterials,
FVector2f OffsetUVs,
bool bOverrideBoxDimensionsWithBounds,
bool bCenterBoxAtPivot,
bool bUniformProjectionScale
)

 Box project UVs FractureAutoUV.h  

bool UE::PlanarCut::UVLayout ( int32 TargetUVLayer,
FGeometryCollection& Collection,
int32 UVRes,
float GutterSize,
EUseMaterials MaterialsPattern,
TArrayView< int32 > WhichMaterials,
bool bRecreateUVsForDegenerateIslands,
FProgressCancel* Progress
)

 Make a UV atlas of non-overlapping UV charts for a geometry collection FractureAutoUV.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page