AI3DHDrawing Class Reference

instant3Dhub: AI3DHDrawing Class Reference
instant3Dhub

#include "I3DHDrawing.h"

+ Inheritance diagram for AI3DHDrawing:
+ Collaboration diagram for AI3DHDrawing:

Detailed Description

This actor is the scene representation of drawings in the session.

It takes Hub specific data as input and generates the Unreal representation.

Public Member Functions

int GetDrawingHandle () const
 
class AI3DHConnectorGetHubConnector () const
 
virtual void OnHoverStart ()
 
virtual void OnHoverEnd ()
 
virtual UMaterialInterfaceGetHoveredMaterial (const FLinearColor &DrawingColor) const
 
void SetDrawingVisibilityOverride (const bool bIsVisible)
 
void ClearDrawingVisibilityOverride ()
 

Public Attributes

uint8 bCreateDrawingCollisions: 1
 

Member Function Documentation

◆ GetDrawingHandle()

int AI3DHDrawing::GetDrawingHandle ( ) const
inline

Gets instant3Dhub Drawing Handle of this Drawing Actor.

Returns
The drawing handle.

◆ GetHoveredMaterial()

virtual UMaterialInterface * AI3DHDrawing::GetHoveredMaterial ( const FLinearColor & DrawingColor) const
inlinevirtual

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

Parameters
DrawingColorThe drawing color.
Returns
Nullptr if the material should not change for a hovered drawing, else the hovered material.

Reimplemented in AI3DHEditableDrawing.

◆ GetHubConnector()

class AI3DHConnector * AI3DHDrawing::GetHubConnector ( ) const
inline

Gets hub connector that's connected to the instant3Dhub session this drawing belongs to.

Returns
Nullptr if it fails, else the hub connector.

◆ SetDrawingVisibilityOverride()

void AI3DHDrawing::SetDrawingVisibilityOverride ( const bool bIsVisible)

Overrides the visibility of the Drawing disregarding the visibility of the instant3Dhub session.

Note
This only applies to Unreal Engine and is not synced with the instant3Dhub Session.
Parameters
bIsVisibleTrue if is visible, false if not.

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