UE::Geometry::FLinearStairGenerator Class Reference

#include <StairGenerator.h>

Inheritance diagram for UE::Geometry::FLinearStairGenerator:

Public Member Functions
	FLinearStairGenerator ()
virtual	~FLinearStairGenerator () override
Public Member Functions inherited from UE::Geometry::FStairGenerator
virtual GEOMETRYCORE_API	~FStairGenerator () override
virtual GEOMETRYCORE_API FMeshShapeGenerator &	Generate () override
Public Member Functions inherited from UE::Geometry::FMeshShapeGenerator
virtual	~FMeshShapeGenerator ()
bool	HasAttributes () const
void	ResetAttributes (bool bResetPolygonIDs=false)
void	Reset ()
void	SetBufferSizes (int NumVertices, int NumTriangles, int NumUVs, int NumNormals)
void	ExtendBufferSizes (int AddVertices, int AddTriangles, int AddUVs, int AddNormals)
void	SetVertex (int Index, const FVector3d &Position)
int	AppendVertex (const FVector3d &Position)
void	SetUV (int Index, const FVector2f &UV, int ParentVertex)
int	AppendUV (const FVector2f &UV, int ParentVertex)
void	SetNormal (int Index, const FVector3f &Normal, int ParentVertex)
int	AppendNormal (const FVector3f &Normal, int ParentVertex)
void	SetTriangle (int Index, const FIndex3i &Tri)
void	SetTriangle (int Index, int A, int B, int C)
void	SetTriangle (int Index, int A, int B, int C, bool bClockwiseOverride)
int	AppendTriangle (int A, int B, int C)
void	SetTriangleUVs (int Index, const FIndex3i &Tri)
void	SetTriangleUVs (int Index, int A, int B, int C)
void	SetTriangleUVs (int Index, int A, int B, int C, bool bClockwiseOverride)
void	SetTriangleNormals (int Index, const FIndex3i &Tri)
void	SetTriangleNormals (int Index, int A, int B, int C)
void	SetTriangleNormals (int Index, int A, int B, int C, bool bClockwiseOverride)
void	SetTrianglePolygon (int Index, int PolygonID)
void	SetTriangleWithMatchedUVNormal (int Index, int A, int B, int C)

Public Attributes
float	StepDepth = 30.0f
Public Attributes inherited from UE::Geometry::FStairGenerator
bool	bScaleUVByAspectRatio = true
bool	bPolygroupPerQuad = false
float	StepWidth = 150.0f
float	StepHeight = 20.0f
int	NumSteps = 8
Public Attributes inherited from UE::Geometry::FMeshShapeGenerator
TArray< FVector3d >	Vertices
TArray< FVector2f >	UVs
TArray< int >	UVParentVertex
TArray< FVector3f >	Normals
TArray< int >	NormalParentVertex
TArray< FIndex3i >	Triangles
TArray< FIndex3i >	TriangleUVs
TArray< FIndex3i >	TriangleNormals
TArray< int >	TrianglePolygonIDs
bool	bReverseOrientation = false

Protected Types
typedef FStairGenerator	Super
Protected Types inherited from UE::Geometry::FStairGenerator
enum class	EStairStyle { Solid , Floating }

Protected Member Functions
virtual GEOMETRYCORE_API FVector3d	GenerateVertex (ESide Side, int VertexColumn, int VertexRow) override
virtual GEOMETRYCORE_API FVector3f	GenerateNormal (ESide Side, int VertexId) override
virtual GEOMETRYCORE_API FVector2f	GenerateUV (ESide Side, int Step, int VertexId, float UVScale) override
virtual GEOMETRYCORE_API float	GetMaxDimension () override
Protected Member Functions inherited from UE::Geometry::FStairGenerator
virtual GEOMETRYCORE_API void	ResetData ()

Additional Inherited Members
Public Types inherited from UE::Geometry::FStairGenerator
enum class	ESide {   Right , Left , Front , Top ,   Back , Bottom }
Static Public Member Functions inherited from UE::Geometry::FMeshShapeGenerator
static FVector3d	BilinearInterp (const FVector3d &v00, const FVector3d &v10, const FVector3d &v11, const FVector3d &v01, double tx, double ty)
static FVector2d	BilinearInterp (const FVector2d &v00, const FVector2d &v10, const FVector2d &v11, const FVector2d &v01, double tx, double ty)
static FVector2f	BilinearInterp (const FVector2f &v00, const FVector2f &v10, const FVector2f &v11, const FVector2f &v01, float tx, float ty)
static FVector3i	LinearInterp (const FVector3i &a, const FVector3i &b, double t)
Protected Attributes inherited from UE::Geometry::FStairGenerator
EStairStyle	StairStyle = EStairStyle::Solid
TArray< TArray< int > >	VertexIds
TArray< FIndex2i >	VertexIdsToColumnRow
TArray< int >	FaceDesc
TArray< int >	NormalDesc
TArray< int >	UVDesc
int	NumQuadsPerSide = 0
int	NumQuads = 0
int	NumVertsPerSide = 0
int	NumVerts = 0
int	NumAttrs = 0
int	RightSideColumnId = 0
int	LeftSideColumnId = 0
int	RightStartFaceId = 0
int	LeftStartFaceId = 0
int	FrontStartFaceId = 0
int	TopStartFaceId = 0
int	BackStartFaceId = 0
int	BottomStartFaceId = 0
int	LastFaceId = 0

Detailed Description

Generate an oriented Linear Stair mesh.

Member Typedef Documentation

Super

typedef FStairGenerator UE::Geometry::FLinearStairGenerator::Super

protected

Constructor & Destructor Documentation

FLinearStairGenerator()

UE::Geometry::FLinearStairGenerator::FLinearStairGenerator ( )

inline

~FLinearStairGenerator()

virtual UE::Geometry::FLinearStairGenerator::~FLinearStairGenerator ( )

inlineoverridevirtual

Member Function Documentation

GenerateNormal()

FVector3f FLinearStairGenerator::GenerateNormal ( ESide  Side, int  VertexId  )

overrideprotectedvirtual

Returns a vertex normal vector.

All normals for a given side are shared except for Front & Top. Border vertex normals per side are not shared.

Parameters

Side	The side of the stairs to compute the normal.
VertexId	The vertex index to compute the normal.

Implements UE::Geometry::FStairGenerator.

GenerateUV()

FVector2f FLinearStairGenerator::GenerateUV ( ESide  Side, int  Step, int  VertexId, float  UVScale  )

overrideprotectedvirtual

Returns a UV vector.

The Step parameter provides the Side-relative face. This indicates which face for a given side is computing its UV.

All UVs for a given side are shared except for Front & Top. Border edges along each side are UV island edges.

Parameters

Side	The side of the stairs to compute the UV.
Step	The Side-relative step face ID.
VertexId	The vertex index to compute the UV.
UVScale	The UV scale

Implements UE::Geometry::FStairGenerator.

Reimplemented in UE::Geometry::FFloatingStairGenerator.

GenerateVertex()

FVector3d FLinearStairGenerator::GenerateVertex ( ESide  Side, int  VertexColumn, int  VertexRow  )

overrideprotectedvirtual

FLinearStairGenerator

Implements UE::Geometry::FStairGenerator.

Reimplemented in UE::Geometry::FFloatingStairGenerator.

GetMaxDimension()

float FLinearStairGenerator::GetMaxDimension ( )

overrideprotectedvirtual

Returns the max dimension of the staircase for the purposes of computing the world UV scale.

Implements UE::Geometry::FStairGenerator.

Member Data Documentation

StepDepth

float UE::Geometry::FLinearStairGenerator::StepDepth = 30.0f

The depth of each step.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/GeometryCore/Public/Generators/StairGenerator.h
• Engine/Source/Runtime/GeometryCore/Private/Generators/StairGenerator.cpp