EditDrawing API

instant3Dhub: EditDrawing API
instant3Dhub

Detailed Description

The EditDrawing API is an Unreal Engine-specific API that provides a generic entry point to edit a drawing by passing an object that implements II3DHEditDrawingInterface.

The interface decides what can be edited and how.

For typical use, you can rely on the built-in editor AI3DHDrawingEditor (an implementation of II3DHEditDrawingInterface). See the AI3DHDrawingEditor class for usage details.

Classes

class  FI3DHEditDrawingAPI
 
class  UI3DHEditDrawingGeometryProvider
 
class  II3DHEditDrawingInterface
 

Functions

virtual void AI3DHConnector::EditDrawing (int32 DrawingHandle, const TScriptInterface< class II3DHEditDrawingInterface > &EditDrawingInterface, bool bIsEditingCopy=false)
 
virtual void FI3DHEditDrawingAPI::EditDrawing (int32 DrawingHandle, const TScriptInterface< class II3DHEditDrawingInterface > &EditDrawingInterface, bool bIsEditingCopy=false)=0
 

Function Documentation

◆ EditDrawing() [1/2]

virtual void AI3DHConnector::EditDrawing ( int32 DrawingHandle,
const TScriptInterface< class II3DHEditDrawingInterface > & EditDrawingInterface,
bool bIsEditingCopy = false )
virtual

Edit a drawing matching the specified handle using the provided edit drawing interface.

Which types of drawings can be edited and how they are edited is defined by the given II3DHEditDrawingInterface implementation (e.g. AI3DHDrawingEditor).

Parameters
DrawingHandleHandle of the drawing to edit.
EditDrawingInterfaceObject implementing II3DHEditDrawingInterface to perform the edit.
bIsEditingCopy- If true, editing operates on a cloned copy and source drawing is left unchanged.
  • If false (default), the geometry of the drawing is directly modified.
Note
The exact lifecycle of edits is documented in the II3DHEditDrawingInterface::BeginEditDrawing function.

◆ EditDrawing() [2/2]

virtual void FI3DHEditDrawingAPI::EditDrawing ( int32 DrawingHandle,
const TScriptInterface< class II3DHEditDrawingInterface > & EditDrawingInterface,
bool bIsEditingCopy = false )
pure virtual

Edit a drawing matching the specified handle using the provided edit drawing interface.

Experimental
Introduced in v1.1.0. "The instant3Dhub EditDrawing API is available as a preview and is actively under development."
This API is experimental. As such, there is no guarantee that it won't change or be removed in future releases. Please use at your own risk.

Which types of drawings can be edited and how they are edited is defined by the given II3DHEditDrawingInterface implementation (e.g. AI3DHDrawingEditor).

Parameters
DrawingHandleHandle of the drawing to edit.
EditDrawingInterfaceObject implementing II3DHEditDrawingInterface to perform the edit.
bIsEditingCopy- If true, editing operates on a cloned copy and source drawing is left unchanged.
  • If false (default), the geometry of the drawing is directly modified.
Note
The exact lifecycle of edits is documented in the II3DHEditDrawingInterface::BeginEditDrawing function.