AI3DHEditableDrawing Class Reference

instant3Dhub: AI3DHEditableDrawing Class Reference

instant3Dhub

#include "I3DHEditableDrawing.h"

Inheritance diagram for AI3DHEditableDrawing:

Collaboration diagram for AI3DHEditableDrawing:

Detailed Description

An Editable Drawing is a drawing with collision data and can work in conjunction with DrawingEditor to edit previously created drawings.

Public Member Functions
const TArray< FI3DHSplineData > &	GetSplines () const

virtual UMaterialInterface *	GetHoveredMaterial (const FLinearColor &DrawingColor) const override

class AI3DHDrawingEditor *	EditDrawing ()

Public Member Functions inherited from AI3DHDrawing
int	GetDrawingHandle () const

class AI3DHConnector *	GetHubConnector () const

virtual void	OnHoverStart ()

virtual void	OnHoverEnd ()

void	SetDrawingVisibilityOverride (const bool bIsVisible)

void	ClearDrawingVisibilityOverride ()

Additional Inherited Members
Public Attributes inherited from AI3DHDrawing
uint8	bCreateDrawingCollisions: 1

Member Function Documentation

◆ EditDrawing()

class AI3DHDrawingEditor * AI3DHEditableDrawing::EditDrawing ( )

Edit drawing returns a DrawingEditor that allows to edit this Drawing.

Note: If this Drawing is already being edited, returns the existing DrawingEditor.

Calling this immediately hides this Actor and renders the Drawing using the DrawingEditor. This Drawing is automatically updated based when the DrawingEditor Actor is destroyed following these rules:

The DrawingEditor Mode is NOT finalized (see EI3DHDrawingEditorMode::Finalize) --> Restore the old unedited State of the Drawing. No changes are synced to the instant3Dhub Session.
The DrawingEditor Mode is finalized (see EI3DHDrawingEditorMode::Finalize) --> Create a new Drawing in the instant3Dhub Session. Destroy this EditableDrawing Actor. Create a new EditableDrawing Actor.
Returns
Nullptr if it fails, else a pointer to an AI3DHDrawingEditor.

◆ GetHoveredMaterial()

virtual UMaterialInterface * AI3DHEditableDrawing::GetHoveredMaterial ( const FLinearColor & DrawingColor ) const

overridevirtual

Virtual function that can be implemented by derived classes to specify a material for hovered drawings.

Parameters

DrawingColor The drawing color.

Returns: Nullptr if the material should not change for a hovered drawing, else the hovered material.

Reimplemented from AI3DHDrawing.

◆ GetSplines()

const TArray< FI3DHSplineData > & AI3DHEditableDrawing::GetSplines ( ) const

inline

Gets the splines.

Returns: The splines.

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

I3DHEditableDrawing.h