instant3Dhub - Unreal
1.0.0
Home
Introduction
Getting Started
Requirements
Access to instant3Dhub
Recommended System Specifications
Version Compatibility
Project setup and plugin installation
Core Concepts
Plugin Workflow
Hub Connector
Session
Culling and Geometry Streaming
Coordinate Systems
Async APIs
Release Notes
v1.0.0
Version & Compatibility
Semantic Versioning
Compatibility Overview
Recommended Unreal Engine Version
FAQs
Why can’t I disconnect from an instant3Dhub session or connect to a different session?
I’m experiencing issues with the instant3Dhub Plugin, such as connection problems, unexpected behavior or runtime crashes. How can I get help?
Why does some geometry appear transparent even though it should be fully opaque?
Topics
Async API
C++
Lifetime Considerations
Futures
Blueprint
Physics Collisions and instant3Dhub
instant3Dhub Geometry Collisions
instant3Dhub Drawing Collisions
Collisions and Clip Planes
API Reference
Topics
Connector
Disconnect
instant3Dhub Interfaces
ClipPlane API
Drawing API
InstanceGraph API
Selection API
Snapshot API
instant3Dhub Unreal Interfaces
Transform Authority API
Hover API
Coordinate Systems
Plugin Version
Deprecated and Experimental Compiler Warnings
Blueprint Actions
instant3Dhub Auth
instant3Dhub Drawings
instant3Dhub
Classes
Class List
AI3DHAuthHandler
AI3DHConnector
AI3DHDrawing
AI3DHDrawingEditor
AI3DHEditableDrawing
AI3DHGeometry
AI3DHInteractiveSplatDrawing
AI3DHInteractiveSplineDrawing
FI3DHClipPlaneAPI
FI3DHConnectorAPI
FI3DHDrawingAPI
FI3DHHoverAPI
FI3DHInstanceGraphAPI
FI3DHSelectionAPI
FI3DHSnapshotAPI
FI3DHTransformAuthorityAPI
UI3DHUtilities
UI3DHVersion
UInstant3DHubDrawingSettings
UInstant3DHubSettings
Class Index
Class Hierarchy
Class Members
All
Functions
Variables
File List
Guides
How to integrate OAuth-based authorization using the I3DHAuthHandler
How to select instant3Dhub-Geometry with LineTraces
1. Constrain the Ray by ClipPlanes
2. Find instant3Dhub Geometry hit by a Ray
3. Select the Geometry Actor
Final result
instant3Dhub - Unreal
instant3Dhub: Topics
Topics
instant3Dhub: Topics
instant3Dhub
Topics
Here is a list of all topics with brief descriptions:
[detail level
1
2
3
4
]
▼
Connector
The connector is the central actor of the Unreal Plugin and manages the connection with the instant3Dhub
Disconnect
Blueprint Action for
AI3DHConnector::Disconnect
▼
instant3Dhub Interfaces
General instant3Dhub functionality grouped by feature
▼
ClipPlane API
Clip planes hide the geometry on one side of a user-defined plane to reveal the interior of a 3D model
Get Clip Planes
Blueprint Action for
AI3DHConnector::GetClipPlanes
Drawing API
Drawings are freeform 2D or 3D markups that are stored in the session
InstanceGraph API
Tree structure defining the content displayed in instant3Dhub
Selection API
Control which Nodes are selected
Snapshot API
Snapshots are a subset of a 3D Space and describe a momentary state, which includes the state of the InstanceGraph and other elements of the 3D Space like ClipPlanes
▼
instant3Dhub Unreal Interfaces
Unreal Engine-specific instant3Dhub functionality
Transform Authority API
API to locally transform Nodes in Unreal, hiding visual latency of movement while keeping the instant3Dhub synced
Hover API
API to locally hover Nodes in Unreal
Coordinate Systems
Describes the coordinate systems used in instant3Dhub products and the transformations between them
Plugin Version
Utilities to retrieve the instant3Dhub Unreal Plugin version
Deprecated and Experimental Compiler Warnings
Macros marking deprecated and experimental APIs and for controlling warning levels
▼
Blueprint Actions
▼
instant3Dhub Auth
Init
Blueprint Action for
AI3DHAuthHandler::Init
Reset
Blueprint Action for
AI3DHAuthHandler::Reset
Start
Blueprint Action for
AI3DHAuthHandler::Start
▼
instant3Dhub Drawings
Add Point
Blueprint Action for
AI3DHDrawingEditor::AddPoint
Add Point at Cursor
Blueprint Action for
AI3DHDrawingEditor::AddPointAtCursor
Add Spline Point at Cursor
Blueprint Action for
AI3DHInteractiveSplineDrawing::AddSplinePointAtCursor
Async Create Hub Drawing and Destroy
Async Blueprint Action with Target
AI3DHDrawingEditor
Async Finalize Drawing
Async Blueprint Action with Target
AI3DHInteractiveSplatDrawing
Async Finalize Drawing (Experimental)
Async Blueprint Action with Target
AI3DHDrawingEditor
Begin New Spline
Blueprint Action for
AI3DHDrawingEditor::BeginNewSpline
Begin New Spline Slice
Blueprint Action for
AI3DHDrawingEditor::BeginNewSplineSlice
Clear
Blueprint Action for
AI3DHDrawingEditor::Clear
Create Drawing Editor
Blueprint Action for
AI3DHDrawingEditor::CreateDrawingEditor
Create Interactive Splat Drawing
Blueprint Action for
AI3DHInteractiveSplatDrawing::CreateInteractiveSplatDrawing
Create Interactive Spline Drawing
Blueprint Action for
AI3DHInteractiveSplineDrawing::CreateInteractiveSplineDrawing
Draw at Brush
Blueprint Action for
AI3DHInteractiveSplatDrawing::DrawAtBrush
Edit Drawing
Blueprint Action for
AI3DHEditableDrawing::EditDrawing
Erase at Brush
Blueprint Action for
AI3DHInteractiveSplatDrawing::EraseAtBrush
Finish Active Spline
Blueprint Action for
AI3DHInteractiveSplineDrawing::FinishActiveSpline
Get Brush and Eraser Color
Pure Blueprint Action for
AI3DHInteractiveSplatDrawing::GetBrushAndEraserColor
Get Drawing Color
Pure Blueprint Action for
AI3DHDrawingEditor::GetDrawingColor
Get Drawing Editor Mode
Pure Blueprint Action for
AI3DHDrawingEditor::GetDrawingEditorMode
Get Drawing Scale
Pure Blueprint Action for
AI3DHInteractiveSplineDrawing::GetDrawingScale
Get Hub Connector
Pure Blueprint Action for
AI3DHInteractiveSplineDrawing::GetHubConnector
Get Splines
Pure Blueprint Action for
AI3DHDrawingEditor::GetSplines
Init from Splines
Blueprint Action for
AI3DHDrawingEditor::InitFromSplines
Is Empty
Pure Blueprint Action for
AI3DHInteractiveSplatDrawing::IsEmpty
Load Interactive Drawing Active Material
Pure Blueprint Action for
UInstant3DHubDrawingSettings::LoadInteractiveDrawingActiveMaterial
Load Interactive Drawing Active Transient Material
Pure Blueprint Action for
UInstant3DHubDrawingSettings::LoadInteractiveDrawingActiveTransientMaterial
Load Interactive Drawing Hovered Material
Pure Blueprint Action for
UInstant3DHubDrawingSettings::LoadInteractiveDrawingHoveredMaterial
Load Interactive Drawing Material
Pure Blueprint Action for
UInstant3DHubDrawingSettings::LoadInteractiveDrawingMaterial
Load Interactive Drawing Transient Material
Pure Blueprint Action for
UInstant3DHubDrawingSettings::LoadInteractiveDrawingTransientMaterial
Move Brush To
Blueprint Action for
AI3DHInteractiveSplatDrawing::MoveBrushTo
Move Cursor To
Blueprint Action for
AI3DHDrawingEditor::MoveCursorTo
Num Splines
Pure Blueprint Action for
AI3DHDrawingEditor::NumSplines
Remove Last Segment from Active Spline
Blueprint Action for
AI3DHInteractiveSplineDrawing::RemoveLastSegmentFromActiveSpline
Remove Last Spline Slice
Blueprint Action for
AI3DHDrawingEditor::RemoveLastSplineSlice
Select Nearest Point
Blueprint Action for
AI3DHDrawingEditor::SelectNearestPoint
Select Nearest Point at Cursor
Blueprint Action for
AI3DHDrawingEditor::SelectNearestPointAtCursor
Set Brush Hidden in Game
Blueprint Action for
AI3DHInteractiveSplatDrawing::SetBrushHiddenInGame
Set Brush and Eraser Color
Blueprint Action for
AI3DHInteractiveSplatDrawing::SetBrushAndEraserColor
Set Cursor Hidden in Game
Blueprint Action for
AI3DHInteractiveSplineDrawing::SetCursorHiddenInGame
Set Drawing Color
Blueprint Action for
AI3DHDrawingEditor::SetDrawingColor
Set Drawing Mode
Blueprint Action for
AI3DHDrawingEditor::SetDrawingMode
Set Drawing Scale
Blueprint Action for
AI3DHInteractiveSplineDrawing::SetDrawingScale
Set Omit Stroke Start and End Joints
Blueprint Action for
AI3DHDrawingEditor::SetOmitStrokeStartAndEndJoints
Set Show Active Slice Control Points
Blueprint Action for
AI3DHDrawingEditor::SetShowActiveSliceControlPoints
▼
instant3Dhub
►
Clip Plane API
Async Change Clip Plane
Async Blueprint Action with Target
AI3DHConnector
Async Create Clip Plane
Async Blueprint Action with Target
AI3DHConnector
Async Disable Main Clip Plane
Async Blueprint Action with Target
AI3DHConnector
Async Enable Main Clip Plane
Async Blueprint Action with Target
AI3DHConnector
Async Get Clip Plane Properties
Async Blueprint Action with Target
AI3DHConnector
Async Remove Clip Plane
Async Blueprint Action with Target
AI3DHConnector
Find Clip Plane Actor
Blueprint Action for
AI3DHConnector::FindClipPlaneActor
Get Clip Planes
Blueprint Action for
AI3DHConnector::GetClipPlanes
Get Main Clip Plane Actor
Blueprint Action for
AI3DHConnector::GetMainClipPlaneActor
►
Connector
Add Network Credential Cookie
Blueprint Action for
AI3DHConnector::AddNetworkCredentialCookie
Add Network Credential Token
Blueprint Action for
AI3DHConnector::AddNetworkCredentialToken
Connect to Hub
Blueprint Action for
AI3DHConnector::ConnectToHub
Connect to Hub with Options
Blueprint Action for
AI3DHConnector::ConnectToHubWithOptions
Disconnect
Blueprint Action for
AI3DHConnector::Disconnect
Get Hub URL
Pure Blueprint Action for
AI3DHConnector::GetHubURL
Get Network Credential Cookies
Pure Blueprint Action for
AI3DHConnector::GetNetworkCredentialCookies
Get Network Credential Tokens
Pure Blueprint Action for
AI3DHConnector::GetNetworkCredentialTokens
Get Origin to World Transform
Pure Blueprint Action for
AI3DHConnector::GetOriginToWorldTransform
Get Session Id
Pure Blueprint Action for
AI3DHConnector::GetSessionId
Get World to Origin Transform
Pure Blueprint Action for
AI3DHConnector::GetWorldToOriginTransform
Is Connected to Hub
Pure Blueprint Action for
AI3DHConnector::IsConnectedToHub
Is Disconnected
Pure Blueprint Action for
AI3DHConnector::IsDisconnected
Is Establishing Connection to Hub
Pure Blueprint Action for
AI3DHConnector::IsEstablishingConnectionToHub
Remove Network Credential Cookie
Blueprint Action for
AI3DHConnector::RemoveNetworkCredentialCookie
Remove Network Credential Token
Blueprint Action for
AI3DHConnector::RemoveNetworkCredentialToken
►
Drawing API
Async Get Drawings
Async Blueprint Action with Target
AI3DHConnector
Async Remove Drawing
Async Blueprint Action with Target
AI3DHConnector
Find Drawing Actor
Blueprint Action for
AI3DHConnector::FindDrawingActor
Get Clip Drawings by Clip Plane
Blueprint Action for
AI3DHConnector::GetClipDrawingsByClipPlane
Get Drawing Material
Blueprint Action for
AI3DHConnector::GetDrawingMaterial
Set Clip Drawings by Clip Plane
Blueprint Action for
AI3DHConnector::SetClipDrawingsByClipPlane
►
Drawing
On Hover End
Blueprint Action for
AI3DHDrawing::OnHoverEnd
On Hover Start
Blueprint Action for
AI3DHDrawing::OnHoverStart
►
Geometry
Get Hub Connector
Pure Blueprint Action for
AI3DHGeometry::GetHubConnector
Get Node Id
Pure Blueprint Action for
AI3DHGeometry::GetNodeId
Is Selected Node
Pure Blueprint Action for
AI3DHGeometry::IsSelectedNode
On Hover End
Blueprint Action for
AI3DHGeometry::OnHoverEnd
On Hover Start
Blueprint Action for
AI3DHGeometry::OnHoverStart
►
Instance Graph API
Async Add Resource
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Bool
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Bool by Name
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Integer
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Integer Array
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Integer Array by Name
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Integer by Name
Async Blueprint Action with Target
AI3DHConnector
Async Get Property JSON
Async Blueprint Action with Target
AI3DHConnector
Async Get Property JSONBy Name
Async Blueprint Action with Target
AI3DHConnector
Async Get Property String
Async Blueprint Action with Target
AI3DHConnector
Async Get Property String Array
Async Blueprint Action with Target
AI3DHConnector
Async Get Property String Array by Name
Async Blueprint Action with Target
AI3DHConnector
Async Get Property String by Name
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Transform
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Transform by Name
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Volume
Async Blueprint Action with Target
AI3DHConnector
Async Get Property Volume by Name
Async Blueprint Action with Target
AI3DHConnector
Async Get Property World Transform
Async Blueprint Action with Target
AI3DHConnector
Async Remove Resource
Async Blueprint Action with Target
AI3DHConnector
Async Reset Property
Async Blueprint Action with Target
AI3DHConnector
Async Reset Property by Name
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Bool
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Bool by Name
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Integer
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Integer Array
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Integer Array by Name
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Integer by Name
Async Blueprint Action with Target
AI3DHConnector
Async Set Property JSON
Async Blueprint Action with Target
AI3DHConnector
Async Set Property JSONBy Name
Async Blueprint Action with Target
AI3DHConnector
Async Set Property String
Async Blueprint Action with Target
AI3DHConnector
Async Set Property String Array
Async Blueprint Action with Target
AI3DHConnector
Async Set Property String Array by Name
Async Blueprint Action with Target
AI3DHConnector
Async Set Property String by Name
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Transform
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Transform by Name
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Volume
Async Blueprint Action with Target
AI3DHConnector
Async Set Property Volume by Name
Async Blueprint Action with Target
AI3DHConnector
Async Set Property World Transform
Async Blueprint Action with Target
AI3DHConnector
Get Global Root Node Id
Pure Blueprint Action for
AI3DHConnector::GetGlobalRootNodeId
►
Selection API
Async Add to Selection
Async Blueprint Action with Target
AI3DHConnector
Async Clear Selection
Async Blueprint Action with Target
AI3DHConnector
Get Selection
Blueprint Action for
AI3DHConnector::GetSelection
►
Snapshot API
Async Get Snapshots
Async Blueprint Action with Target
AI3DHConnector
Async Restore Snapshot
Async Blueprint Action with Target
AI3DHConnector
►
Transform Authority API
Async Acquire TransformAuthority (Experimental)
Async Blueprint Action with Target
AI3DHConnector
►
Transform Authority
Get WorldTransform With Authority (Experimental)
Blueprint Action for
AI3DHConnector::GetWorldTransformWithAuthority
Is TransformAuthority Active (Experimental)
Pure Blueprint Action for
AI3DHConnector::IsTransformAuthorityActive
Release TransformAuthority (Experimental)
Blueprint Action for
AI3DHConnector::ReleaseTransformAuthority
Set WorldTransform With Authority (Experimental)
Blueprint Action for
AI3DHConnector::SetWorldTransformWithAuthority
►
Utilities
Analyze Hit Result
Blueprint Action for
UI3DHUtilities::AnalyzeHitResult
Async Find First Unselected Ancestor
Async Blueprint Action with Target
AI3DHConnector
Clip Line Segment by Clip Planes
Blueprint Action for
UI3DHUtilities::ClipLineSegmentByClipPlanes
Clip Line Segment by Main Clip Plane
Blueprint Action for
UI3DHUtilities::ClipLineSegmentByMainClipPlane
Clip Line Segment by Plane
Blueprint Action for
UI3DHUtilities::ClipLineSegmentByPlane
Convert Transform Original to Unreal
Blueprint Action for
UI3DHUtilities::ConvertTransformOriginalToUnreal
Convert Transform Original to Unreal (Pure)
Pure Blueprint Action for
UI3DHUtilities::ConvertTransformOriginalToUnrealPure
Convert Transform Unreal to Original
Blueprint Action for
UI3DHUtilities::ConvertTransformUnrealToOriginal
Convert Transform Unreal to Original (Pure)
Pure Blueprint Action for
UI3DHUtilities::ConvertTransformUnrealToOriginalPure
Convert Volume Original to Unreal
Blueprint Action for
UI3DHUtilities::ConvertVolumeOriginalToUnreal
Convert Volume Original to Unreal (Pure)
Pure Blueprint Action for
UI3DHUtilities::ConvertVolumeOriginalToUnrealPure
Convert Volume Unreal to Original
Blueprint Action for
UI3DHUtilities::ConvertVolumeUnrealToOriginal
Convert Volume Unreal to Original (Pure)
Pure Blueprint Action for
UI3DHUtilities::ConvertVolumeUnrealToOriginalPure
Get Original to Unreal Matrix
Pure Blueprint Action for
UI3DHUtilities::GetOriginalToUnrealMatrix
Get Original to Unreal Normal Matrix
Pure Blueprint Action for
UI3DHUtilities::GetOriginalToUnrealNormalMatrix
Get Original to Unreal Scale
Pure Blueprint Action for
UI3DHUtilities::GetOriginalToUnrealScale
Get URLQuery Params
Blueprint Action for
UI3DHUtilities::GetURLQueryParams
Get Unreal to Original Matrix
Pure Blueprint Action for
UI3DHUtilities::GetUnrealToOriginalMatrix
Get Unreal to Original Normal Matrix
Pure Blueprint Action for
UI3DHUtilities::GetUnrealToOriginalNormalMatrix
Is Editor Standalone Game
Pure Blueprint Action for
UI3DHUtilities::IsEditorStandaloneGame
Is with Editor
Pure Blueprint Action for
UI3DHUtilities::IsWithEditor
Make Plane from Clip Plane Actor
Blueprint Action for
UI3DHUtilities::MakePlaneFromClipPlaneActor
UEColor to Webvis Appearance URI
Blueprint Action for
UI3DHUtilities::UEColorToWebvisAppearanceURI
Webvis Appearance URITo UEColor
Blueprint Action for
UI3DHUtilities::WebvisAppearanceURIToUEColor
►
Version
Get Plugin Version Major
Pure Blueprint Action for
UI3DHVersion::GetPluginVersionMajor
Get Plugin Version Minor
Pure Blueprint Action for
UI3DHVersion::GetPluginVersionMinor
Get Plugin Version Patch
Pure Blueprint Action for
UI3DHVersion::GetPluginVersionPatch
Get Plugin Version String
Pure Blueprint Action for
UI3DHVersion::GetPluginVersionString
Generated by
1.12.0