UI3DHEditDrawingGeometryProvider Class Reference

instant3Dhub: UI3DHEditDrawingGeometryProvider Class Reference

instant3Dhub

#include "I3DHDataTypes.h"

Inheritance diagram for UI3DHEditDrawingGeometryProvider:

Collaboration diagram for UI3DHEditDrawingGeometryProvider:

Detailed Description

Provides access to geometry of an instant3Dhub drawing.

Note: Used in conjunction with UI3DHEditDrawingInterface and AI3DHConnector::EditDrawing

Public Member Functions
int32	GetNumGeometries () const

FBox	GetGeometryVolume (int32 GeometryIndex) const

EI3DHGlPrimitiveType	GetGeometryPrimitiveType (int32 GeometryIndex) const

FLinearColor	GetGeometryColor (int32 GeometryIndex) const

float	GetGeometryWidth (int32 GeometryIndex) const

bool	GetGeometryUseWorldUnits (int32 GeometryIndex) const

bool	IsEditingCopy () const

bool	AcquireGeometry (int32 GeometryIndex, FI3DHDrawingGeometry &OutGeometry) const

Member Function Documentation

◆ AcquireGeometry()

bool UI3DHEditDrawingGeometryProvider::AcquireGeometry	(	int32	GeometryIndex,
		FI3DHDrawingGeometry &	OutGeometry ) const

Tries to acquire the geometry at the given index and returns it in OutGeometry.

Acquiring geometry means ownership is transferred to the caller.

Parameters

GeometryIndex	Index of the geometry to acquire.
OutGeometry	Receives the acquired geometry.

Returns: True if the geometry was successfully acquired, false if it was already acquired or the index is invalid.

◆ GetGeometryColor()

FLinearColor UI3DHEditDrawingGeometryProvider::GetGeometryColor ( int32 GeometryIndex ) const

Returns the color of the geometry at the given index.

Parameters

GeometryIndex Index of the geometry to retrieve.

Returns: Color of the geometry at the given index.

◆ GetGeometryPrimitiveType()

EI3DHGlPrimitiveType UI3DHEditDrawingGeometryProvider::GetGeometryPrimitiveType ( int32 GeometryIndex ) const

Returns the primitive type of the geometry at the given index.

Parameters

GeometryIndex Index of the geometry to retrieve.

Returns: Primitive type of the geometry at the given index.

◆ GetGeometryUseWorldUnits()

bool UI3DHEditDrawingGeometryProvider::GetGeometryUseWorldUnits ( int32 GeometryIndex ) const

Returns whether the width of the geometry at the given index is given in screen space or world space.

Parameters

GeometryIndex Index of the geometry to retrieve.

Returns: True if the width is in world space (centimeters), false if it is in screen space (pixels).

◆ GetGeometryVolume()

FBox UI3DHEditDrawingGeometryProvider::GetGeometryVolume ( int32 GeometryIndex ) const

Returns the volume of the geometry at the given index.

Parameters

GeometryIndex Index of the geometry to retrieve.

Returns: Volume of the geometry at the given index.

◆ GetGeometryWidth()

float UI3DHEditDrawingGeometryProvider::GetGeometryWidth ( int32 GeometryIndex ) const

Returns the width of the geometry at the given index.

Parameters

GeometryIndex Index of the geometry to retrieve.

Returns: Width of the geometry at the given index.

◆ GetNumGeometries()

int32 UI3DHEditDrawingGeometryProvider::GetNumGeometries ( ) const

inline

Returns the number of geometries in the drawing result.

Returns: Number of geometries in the drawing result.

◆ IsEditingCopy()

bool UI3DHEditDrawingGeometryProvider::IsEditingCopy ( ) const

inline

Returns whether the drawing was edited as a copy or not.

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

I3DHDataTypes.h