Hover API

Hover API#

instant3Dhub: Hover API
instant3Dhub
Classes | Functions
Hover API
instant3Dhub Unreal Interfaces

Detailed Description

API to locally hover Nodes in Unreal.

Classes

class  FI3DHHoverAPI

Functions

void AI3DHConnector::SetHoveredNode (int32 NodeId)
void AI3DHConnector::AddToHoveredNodes (int32 NodeId)
void AI3DHConnector::ClearHoveredNodes ()
TArray< int32 > AI3DHConnector::GetHoveredNodes ()
virtual void FI3DHHoverAPI::SetHoveredNode (int32 NodeId)=0
virtual void FI3DHHoverAPI::AddToHoveredNodes (int32 NodeId)=0
virtual void FI3DHHoverAPI::ClearHoveredNodes ()=0
virtual TArray< int32 > FI3DHHoverAPI::GetHoveredNodes ()=0

Function Documentation

◆ AddToHoveredNodes() [1/2]

void AI3DHConnector::AddToHoveredNodes ( int32 NodeId)

Adds the given node to the set of hovered nodes.

Note
Must be called from the game thread.
Parameters
NodeIdThe id of the node that should be added to the hovered nodes.

◆ AddToHoveredNodes() [2/2]

virtual void FI3DHHoverAPI::AddToHoveredNodes ( int32 NodeId)
pure virtual

Adds the given node to the set of hovered nodes.

Note
Must be called from the game thread.
Parameters
NodeIdThe id of the node that should be added to the hovered nodes.

◆ ClearHoveredNodes() [1/2]

void AI3DHConnector::ClearHoveredNodes ( )

Clears the set of hovered nodes.

Note
Must be called from the game thread.

◆ ClearHoveredNodes() [2/2]

virtual void FI3DHHoverAPI::ClearHoveredNodes ( )
pure virtual

Clears the set of hovered nodes.

Note
Must be called from the game thread.

◆ GetHoveredNodes() [1/2]

TArray< int32 > AI3DHConnector::GetHoveredNodes ( )

Returns the current list of hovered nodes.

Note
Must be called from the game thread.
Returns
An array containing the IDs of the currently hovered nodes.

◆ GetHoveredNodes() [2/2]

virtual TArray< int32 > FI3DHHoverAPI::GetHoveredNodes ( )
pure virtual

Returns the current list of hovered nodes.

Note
Must be called from the game thread.
Returns
An array containing the IDs of the currently hovered nodes.

◆ SetHoveredNode() [1/2]

void AI3DHConnector::SetHoveredNode ( int32 NodeId)

Replaces the set of hovered nodes with the given node.

Has the same effect as AI3DHConnector::ClearHoveredNodes() followed by AI3DHConnector::AddToHoveredNodes().

Note
Must be called from the game thread.
Parameters
NodeIdThe id of the node that should be hovered.

◆ SetHoveredNode() [2/2]

virtual void FI3DHHoverAPI::SetHoveredNode ( int32 NodeId)
pure virtual

Replaces the set of hovered nodes with the given node.

Has the same effect as FI3DHHoverAPI::ClearHoveredNodes() followed by FI3DHHoverAPI::AddToHoveredNodes().

Note
Must be called from the game thread.
Parameters
NodeIdThe id of the node that should be hovered.
Generated by doxygen 1.14.0