AI3DHDrawing Class Reference

instant3Dhub: AI3DHDrawing Class Reference
instant3Dhub
Public Member Functions | Public Attributes | List of all members
AI3DHDrawing Class Reference

#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

int32 GetDrawingHandle () const
 
class AI3DHConnector * GetHubConnector () const
 
virtual void OnHoverStart ()
 
virtual void OnHoverEnd ()
 
virtual UMaterialInterface * GetHoveredMaterial (const FLinearColor &DrawingColor) const
 
void SetDrawingVisibilityOverride (const bool bIsVisible)
 
void ClearDrawingVisibilityOverride ()
 
bool HasDrawingResult () const
 

Public Attributes

TSet< EI3DHGlPrimitiveType > AllowedPrimitivesColliders {EI3DHGlPrimitiveType::LINE_STRIP}
 
uint8 bCreateDrawingCollisions: 1
 

Member Function Documentation

◆ ClearDrawingVisibilityOverride()

void AI3DHDrawing::ClearDrawingVisibilityOverride ( )

Clears any active visibility override and restores the drawing's instant3Dhub session visibility.

◆ GetDrawingHandle()

int32 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
Deprecated
Deprecated in v1.1.0. "GetHoveredMaterial is no longer used."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ 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.

◆ HasDrawingResult()

bool AI3DHDrawing::HasDrawingResult ( ) const
inline

Returns true if this Drawing Actor has a valid Drawing Result.

◆ OnHoverEnd()

virtual void AI3DHDrawing::OnHoverEnd ( )
virtual

OnHoverEnd should be called if this DrawingActor is no longer hovered to revert its Material.

◆ OnHoverStart()

virtual void AI3DHDrawing::OnHoverStart ( )
virtual

OnHoverStart should be called if this DrawingActor is hovered to change its Material to one that visualizes the Hovered State.

◆ 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.

Member Data Documentation

◆ AllowedPrimitivesColliders

TSet<EI3DHGlPrimitiveType> AI3DHDrawing::AllowedPrimitivesColliders {EI3DHGlPrimitiveType::LINE_STRIP}

Finer control over which geometry types have collisions enabled.

Note
Only relevant if bCreateDrawingCollisions is true.

◆ bCreateDrawingCollisions

uint8 AI3DHDrawing::bCreateDrawingCollisions

Whether drawings should ever have collisions created from their geometry.

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0