Hover API

instant3Dhub: Hover API
instant3Dhub

Detailed Description

API to locally hover Nodes in Unreal.

Classes

class  FI3DHHoverAPI
 

Functions

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()

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()

virtual void FI3DHHoverAPI::ClearHoveredNodes ( )
pure virtual

Clears the set of hovered nodes.

Note
Must be called from the game thread.

◆ GetHoveredNodes()

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()

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

Replaces the set of hovered nodes with the given node.

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

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