FI3DHDrawingGeometry Struct Reference

instant3Dhub: FI3DHDrawingGeometry Struct Reference

instant3Dhub

#include "I3DHDataTypes.h"

Collaboration diagram for FI3DHDrawingGeometry:

Detailed Description

An instant3Dhub drawing geometry.

Public Attributes
FBox	Volume { EForceInit::ForceInitToZero }

float	Width {1}

bool	bUseWorldUnits {false}

EI3DHGlPrimitiveType	PrimitiveType {}

FLinearColor	Color { FLinearColor::Black }

TArray< FVector3f >	Positions {}

TArray< int32 >	Slices

Member Data Documentation

◆ bUseWorldUnits

bool FI3DHDrawingGeometry::bUseWorldUnits {false}

Specifies how the width value is interpreted.

If set to true, the width is interpreted in world space (centimeters) otherwise in screen space (pixels). Only applies to primitive type EI3DHGlPrimitiveType::LINE_STRIP.

Note: Unreal does not support screen space width scaling.

◆ Color

FLinearColor FI3DHDrawingGeometry::Color { FLinearColor::Black }

Specifies the color of the Geometry.

◆ Positions

TArray<FVector3f> FI3DHDrawingGeometry::Positions {}

Specifies the vertex positions of the Geometry.

◆ PrimitiveType

EI3DHGlPrimitiveType FI3DHDrawingGeometry::PrimitiveType {}

Specifies primitive type of the Geometry.

◆ Slices

TArray<int32> FI3DHDrawingGeometry::Slices

Specifies a partition of the vertex list Positions into contiguous sub-ranges (slices).

A slice consists of one or more primitives and represents a higher-level element of the geometry that can be used for user actions, e.g. undo-redo.

Each entry in this array defines a slice by its start vertex index. A slice ends immediately before the start vertex index of the next slice or at the end of the vertex array for the last slice.

The Slices array is optional and can be empty.
The Slices array is a sorted list of integer indices.
The Slices array is always non‐empty whenever there is at least one vertex.
The first slice always starts at the first vertex (i.e. Slices[0] == 0).
If Slices is empty, it means that the geometry has no slices and consists of a single slice containing all vertices.

Example: Given 8 vertices and slices = [0, 3, 6] you get 3 slices:

Slice 0: Vertices 0, 1, 2
Slice 1: Vertices 3, 4, 5
Slice 2: Vertices 6, 7

Note: Slices are specified in terms of vertex indices, not primitive indices.

◆ Volume

FBox FI3DHDrawingGeometry::Volume { EForceInit::ForceInitToZero }

Specifies the volume of the Geometry.

◆ Width

float FI3DHDrawingGeometry::Width {1}

Specifies the width of the Geometry in centimeters.

Only applies to primitive type EI3DHGlPrimitiveType::LINE_STRIP.

The documentation for this struct was generated from the following file:

I3DHDataTypes.h