instant3Dhub Interfaces

instant3Dhub: instant3Dhub Interfaces
instant3Dhub
instant3Dhub Interfaces

Detailed Description

General instant3Dhub functionality grouped by feature.

Topics

 ClipPlane API
 
 Drawing API
 
 InstanceGraph API
 
 Selection API
 
 Snapshot API
 

Classes

class  AI3DHConnector
 
class  FI3DHConnectorAPI
 

Functions

TSharedPtr< FI3DHConnectorAPIAI3DHConnector::GetAPI () const
 
virtual class AI3DHConnectorFI3DHConnectorAPI::GetConnector ()=0
 
virtual FI3DHClipPlaneAPIFI3DHConnectorAPI::GetClipPlaneAPI ()=0
 
virtual FI3DHDrawingAPIFI3DHConnectorAPI::GetDrawingAPI ()=0
 
virtual FI3DHInstanceGraphAPIFI3DHConnectorAPI::GetInstanceGraphAPI ()=0
 
virtual FI3DHSelectionAPIFI3DHConnectorAPI::GetSelectionAPI ()=0
 
virtual FI3DHSnapshotAPIFI3DHConnectorAPI::GetSnapshotAPI ()=0
 

Function Documentation

◆ GetAPI()

TSharedPtr< FI3DHConnectorAPI > AI3DHConnector::GetAPI ( ) const

Returns a shared pointer to the ConnectorAPI.

Using shared pointer semantics, the ConnectorAPI can be kept alive through asynchronous operations, etc. If you need to access the connector again from the ConnectorAPI see FI3DHConnectorAPI::GetConnector().

Returns
A shared pointer to the ConnectorAPI.

◆ GetClipPlaneAPI()

virtual FI3DHClipPlaneAPI * FI3DHConnectorAPI::GetClipPlaneAPI ( )
pure virtual

Gets clip plane API.

Returns
Returns pointer to the ClipPlaneAPI. Never nullptr.

◆ GetConnector()

virtual class AI3DHConnector * FI3DHConnectorAPI::GetConnector ( )
pure virtual

Gets the connector actor belonging to this API.

It's only useful to call this on the game thread. May return nullptr if the actor has already been destroyed.

Returns
Nullptr if it fails, else the connector.

◆ GetDrawingAPI()

virtual FI3DHDrawingAPI * FI3DHConnectorAPI::GetDrawingAPI ( )
pure virtual

Gets drawing API.

Returns
Returns pointer to the DrawingAPI. Never nullptr.

◆ GetInstanceGraphAPI()

virtual FI3DHInstanceGraphAPI * FI3DHConnectorAPI::GetInstanceGraphAPI ( )
pure virtual

Gets instance graph API.

Returns
Returns pointer to the InstanceGraphAPI. Never nullptr.

◆ GetSelectionAPI()

virtual FI3DHSelectionAPI * FI3DHConnectorAPI::GetSelectionAPI ( )
pure virtual

Gets selection API.

Returns
Returns pointer to the SelectionAPI. Never nullptr.

◆ GetSnapshotAPI()

virtual FI3DHSnapshotAPI * FI3DHConnectorAPI::GetSnapshotAPI ( )
pure virtual

Gets snapshot API.

Returns
Returns pointer to the SnapshotAPI. Never nullptr.