InstanceGraph API

instant3Dhub: InstanceGraph API

instant3Dhub

Detailed Description

Tree structure defining the content displayed in instant3Dhub.

The InstanceGraph is a tree of Nodes, resembling a scene graph-like structure. Every Node can contain links to 3D geometry and/or a group of other Nodes.

The InstanceGraphAPI allows you to add and remove Nodes. Typically, a new Node is added at the top-most level, linking to 3D data. Additional Nodes representing the internals of the linked data will be created as a subtree below the original Node. The InstanceGraphAPI also allows you to create custom hierarchies of Nodes to organize your data.

Nodes are the central representation and addressing scheme for 3D content. For example, selection and hovering is controlled on the Node level.

There are getter and setter functions to store properties of arbitrary type on the Nodes. Properties are used to modify any Node-dependent data like color, transformation, etc. There is a set of predefined Node properties, but the surrounding application might add any other property to the Nodes.

Classes
class	FI3DHInstanceGraphAPI

Functions
int32	AI3DHConnector::GetGlobalRootNodeId ()

virtual int32	FI3DHInstanceGraphAPI::GetGlobalRootNodeId ()=0

virtual void	FI3DHInstanceGraphAPI::AddResource (const FString &Url, TUniqueFunction< void(int32 NodeId, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::RemoveResource (int32 NodeId, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::ResetProperty (int32 NodeId, EI3DHProperty Property, bool bRecursive, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::ResetPropertyByName (int32 NodeId, const FString &Property, bool bRecursive, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyBool (int32 NodeId, EI3DHPropertyBool Property, TUniqueFunction< void(bool Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyBool (int32 NodeId, EI3DHPropertyBool Property, bool Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyBoolByName (int32 NodeId, const FString &Property, TUniqueFunction< void(bool Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyBoolByName (int32 NodeId, const FString &Property, bool Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyInteger (int32 NodeId, EI3DHPropertyInteger Property, TUniqueFunction< void(int32 Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyInteger (int32 NodeId, EI3DHPropertyInteger Property, int32 Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyIntegerByName (int32 NodeId, const FString &Property, TUniqueFunction< void(int32 Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyIntegerByName (int32 NodeId, const FString &Property, int32 Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyString (int32 NodeId, EI3DHPropertyString Property, TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyString (int32 NodeId, EI3DHPropertyString Property, const FString &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyStringByName (int32 NodeId, const FString &Property, TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyStringByName (int32 NodeId, const FString &Property, const FString &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyIntegerArray (int32 NodeId, EI3DHPropertyIntegerArray Property, TUniqueFunction< void(TArray< int32 > Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyIntegerArray (int32 NodeId, EI3DHPropertyIntegerArray Property, const TArray< int32 > &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyIntegerArrayByName (int32 NodeId, const FString &Property, TUniqueFunction< void(TArray< int32 > Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyIntegerArrayByName (int32 NodeId, const FString &Property, const TArray< int32 > &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyStringArray (int32 NodeId, EI3DHPropertyStringArray Property, TUniqueFunction< void(TArray< FString > Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyStringArray (int32 NodeId, EI3DHPropertyStringArray Property, const TArray< FString > &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyStringArrayByName (int32 NodeId, const FString &Property, TUniqueFunction< void(TArray< FString > Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyStringArrayByName (int32 NodeId, const FString &Property, const TArray< FString > &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyJSON (int32 NodeId, EI3DHPropertyJSON Property, TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyJSON (int32 NodeId, EI3DHPropertyJSON Property, const FString &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyJSONByName (int32 NodeId, const FString &Property, TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyJSONByName (int32 NodeId, const FString &Property, const FString &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyEnum (int32 NodeId, EI3DHPropertyEnum Property, TUniqueFunction< void(int32 Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyEnum (int32 NodeId, EI3DHPropertyEnum Property, int32 Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyEnumByName (int32 NodeId, const FString &Property, TUniqueFunction< void(int32 Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyEnumByName (int32 NodeId, const FString &Property, int32 Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyTransform (int32 NodeId, EI3DHPropertyTransform Property, TUniqueFunction< void(const FMatrix &Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyTransform (int32 NodeId, EI3DHPropertyTransform Property, const FMatrix &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyTransformByName (int32 NodeId, const FString &Property, TUniqueFunction< void(const FMatrix &Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyTransformByName (int32 NodeId, const FString &Property, const FMatrix &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyVolume (int32 NodeId, EI3DHPropertyVolume Property, TUniqueFunction< void(const FBox &Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyVolume (int32 NodeId, EI3DHPropertyVolume Property, const FBox &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyVolumeByName (int32 NodeId, const FString &Property, TUniqueFunction< void(const FBox &Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyVolumeByName (int32 NodeId, const FString &Property, const FBox &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

template<EI3DHPropertyEnum Property>
void	FI3DHInstanceGraphAPI::GetPropertyEnumTyped (int32 NodeId, TUniqueFunction< void(typename TI3DHValueTypeFromEnumProperty< Property >::Value Value, EI3DHErrorCode ErrorCode)> OnComplete)

template<EI3DHPropertyEnum Property>
void	FI3DHInstanceGraphAPI::SetPropertyEnumTyped (int32 NodeId, typename TI3DHValueTypeFromEnumProperty< Property >::Value Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)

virtual void	FI3DHInstanceGraphAPI::ResetProperty (int32 NodeId, const FString &Property, bool bRecursive, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyI (int NodeId, const FString &Property, int Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyB (int NodeId, const FString &Property, bool Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyS (int NodeId, const FString &Property, const FString &Value, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyI (int NodeId, const FString &Property, TUniqueFunction< void(int Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyIA (int NodeId, const FString &Property, TUniqueFunction< void(TArray< int > Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyB (int NodeId, const FString &Property, TUniqueFunction< void(bool Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyS (int NodeId, const FString &Property, TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::SetPropertyRelativeTransform (int NodeId, EI3DHTransformType Type, const FMatrix &Transform, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0

virtual void	FI3DHInstanceGraphAPI::GetPropertyRelativeTransform (int NodeId, EI3DHTransformType Type, TUniqueFunction< void(const FMatrix &Transform, EI3DHErrorCode ErrorCode)> OnComplete)=0

Function Documentation

◆ AddResource()

virtual void FI3DHInstanceGraphAPI::AddResource	(	const FString &	Url,
		TUniqueFunction< void(int32 NodeId, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Add a resource to the current session.

Parameters

Url	Url to the data resource.
OnComplete	Async callback.

◆ GetGlobalRootNodeId() [1/2]

int32 AI3DHConnector::GetGlobalRootNodeId ( )

Returns the NodeId of the (implicit) top-level node of the instance graph.

Returns: RootNodeId of the global root node.

◆ GetGlobalRootNodeId() [2/2]

virtual int32 FI3DHInstanceGraphAPI::GetGlobalRootNodeId ( )

pure virtual

Returns the NodeId of the (implicit) top-level node of the instance graph.

Returns: RootNodeId of the global root node.

◆ GetPropertyB()

virtual void FI3DHInstanceGraphAPI::GetPropertyB	(	int	NodeId,
		const FString &	Property,
		TUniqueFunction< void(bool Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Returns the value of the boolean property on the Node with the matching id.

Parameters

NodeId	The id of the Node whose property should be read.
Property	Name of the property whose value should be read.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use GetPropertyBool() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ GetPropertyBool()

virtual void FI3DHInstanceGraphAPI::GetPropertyBool	(	int32	NodeId,
		EI3DHPropertyBool	Property,
		TUniqueFunction< void(bool Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a boolean property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyBoolByName()

virtual void FI3DHInstanceGraphAPI::GetPropertyBoolByName	(	int32	NodeId,
		const FString &	Property,
		TUniqueFunction< void(bool Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a boolean property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyEnum()

virtual void FI3DHInstanceGraphAPI::GetPropertyEnum	(	int32	NodeId,
		EI3DHPropertyEnum	Property,
		TUniqueFunction< void(int32 Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads an enum property on the given node.

The value has to be cast to the appropriate enum type. This function does not perform any special type checking in this regard.

If the property is known statically, prefer FI3DHInstanceGraphAPI::GetPropertyEnumTyped.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyEnumByName()

virtual void FI3DHInstanceGraphAPI::GetPropertyEnumByName	(	int32	NodeId,
		const FString &	Property,
		TUniqueFunction< void(int32 Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads an enum property on the given node.

The value has to be cast to the appropriate enum type. This function does not perform any special type checking in this regard.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyEnumTyped()

template<EI3DHPropertyEnum Property>

void FI3DHInstanceGraphAPI::GetPropertyEnumTyped	(	int32	NodeId,
		TUniqueFunction< void(typename TI3DHValueTypeFromEnumProperty< Property >::Value Value, EI3DHErrorCode ErrorCode)>	OnComplete )

inline

Reads an enum property (supplied as template argument) on the given node.

Template Parameters

Property The property which should be read.

Parameters

NodeId	The id of the node.
OnComplete	Async callback.

◆ GetPropertyI()

virtual void FI3DHInstanceGraphAPI::GetPropertyI	(	int	NodeId,
		const FString &	Property,
		TUniqueFunction< void(int Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Returns the value of the integer property on the Node with the matching id.

Parameters

NodeId	The id of the Node whose property should be read.
Property	Name of the property whose value should be read.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use GetPropertyInteger() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ GetPropertyIA()

virtual void FI3DHInstanceGraphAPI::GetPropertyIA	(	int	NodeId,
		const FString &	Property,
		TUniqueFunction< void(TArray< int > Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Returns the value of the integer array property on the Node with the matching id.

Parameters

NodeId	The id of the Node whose property should be read.
Property	Name of the property whose value should be read.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use GetPropertyIntegerArray() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ GetPropertyInteger()

virtual void FI3DHInstanceGraphAPI::GetPropertyInteger	(	int32	NodeId,
		EI3DHPropertyInteger	Property,
		TUniqueFunction< void(int32 Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads an integer property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyIntegerArray()

virtual void FI3DHInstanceGraphAPI::GetPropertyIntegerArray	(	int32	NodeId,
		EI3DHPropertyIntegerArray	Property,
		TUniqueFunction< void(TArray< int32 > Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads an integer array property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyIntegerArrayByName()

virtual void FI3DHInstanceGraphAPI::GetPropertyIntegerArrayByName	(	int32	NodeId,
		const FString &	Property,
		TUniqueFunction< void(TArray< int32 > Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads an integer array property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyIntegerByName()

virtual void FI3DHInstanceGraphAPI::GetPropertyIntegerByName	(	int32	NodeId,
		const FString &	Property,
		TUniqueFunction< void(int32 Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads an integer property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyJSON()

virtual void FI3DHInstanceGraphAPI::GetPropertyJSON	(	int32	NodeId,
		EI3DHPropertyJSON	Property,
		TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a property on the given node as JSON.

Works on any property. If the value is undefined, EI3DHErrorCode::PropertyNotSet will be returned.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyJSONByName()

virtual void FI3DHInstanceGraphAPI::GetPropertyJSONByName	(	int32	NodeId,
		const FString &	Property,
		TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a property on the given node as JSON.

Works on any property. If the value is undefined, EI3DHErrorCode::PropertyNotSet will be returned.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyRelativeTransform()

virtual void FI3DHInstanceGraphAPI::GetPropertyRelativeTransform	(	int	NodeId,
		EI3DHTransformType	Type,
		TUniqueFunction< void(const FMatrix &Transform, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Get a node's local/global transform.

Global transforms are relative to the hub connector.

Parameters

NodeId	The id of the Node whose transform should be read.
Type	The transform type defining whether the local or global transform should be read.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use GetPropertyTransform() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ GetPropertyS()

virtual void FI3DHInstanceGraphAPI::GetPropertyS	(	int	NodeId,
		const FString &	Property,
		TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Returns the value of the string property on the Node with the matching id.

Parameters

NodeId	The id of the Node whose property should be read.
Property	Name of the property whose value should be read.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use GetPropertyString() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ GetPropertyString()

virtual void FI3DHInstanceGraphAPI::GetPropertyString	(	int32	NodeId,
		EI3DHPropertyString	Property,
		TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a string property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyStringArray()

virtual void FI3DHInstanceGraphAPI::GetPropertyStringArray	(	int32	NodeId,
		EI3DHPropertyStringArray	Property,
		TUniqueFunction< void(TArray< FString > Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a string array property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyStringArrayByName()

virtual void FI3DHInstanceGraphAPI::GetPropertyStringArrayByName	(	int32	NodeId,
		const FString &	Property,
		TUniqueFunction< void(TArray< FString > Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a string array property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyStringByName()

virtual void FI3DHInstanceGraphAPI::GetPropertyStringByName	(	int32	NodeId,
		const FString &	Property,
		TUniqueFunction< void(FString Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a string property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyTransform()

virtual void FI3DHInstanceGraphAPI::GetPropertyTransform	(	int32	NodeId,
		EI3DHPropertyTransform	Property,
		TUniqueFunction< void(const FMatrix &Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a transform property on the given node.

This function automatically converts the transform to the Unreal coordinate system, see Coordinate Systems. Refer to the property documentation on how to apply the returned transform. In particular, the returned transforms for EI3DHPropertyTransform::GlobalTransform is relative to the Hub Connector and should not be used as a world transform directly.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyTransformByName()

virtual void FI3DHInstanceGraphAPI::GetPropertyTransformByName	(	int32	NodeId,
		const FString &	Property,
		TUniqueFunction< void(const FMatrix &Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a transform property on the given node.

This function automatically converts the transform to the Unreal coordinate system, see Coordinate Systems. Refer to the property documentation on how to apply the returned transform. In particular, the returned transforms for EI3DHPropertyTransform::GlobalTransform is relative to the Hub Connector and should not be used as a world transform directly.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyVolume()

virtual void FI3DHInstanceGraphAPI::GetPropertyVolume	(	int32	NodeId,
		EI3DHPropertyVolume	Property,
		TUniqueFunction< void(const FBox &Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a volume property on the given node.

This function automatically converts the volume to the Unreal coordinate system, see Coordinate Systems. Refer to the property documentation on how to apply the returned volumes. In particular, the returned volumes for EI3DHPropertyVolume::GlobalVolume is relative to the Hub Connector and should not be used in world space directly.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ GetPropertyVolumeByName()

virtual void FI3DHInstanceGraphAPI::GetPropertyVolumeByName	(	int32	NodeId,
		const FString &	Property,
		TUniqueFunction< void(const FBox &Value, EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Reads a volume property on the given node.

This function automatically converts the volume to the Unreal coordinate system, see Coordinate Systems. Refer to the property documentation on how to apply the returned volumes. In particular, the returned volumes for EI3DHPropertyVolume::GlobalVolume is relative to the Hub Connector and should not be used in world space directly.

Parameters

NodeId	The id of the node.
Property	The property which should be read.
OnComplete	Async callback.

◆ RemoveResource()

virtual void FI3DHInstanceGraphAPI::RemoveResource	(	int32	NodeId,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Remove a resource from the current session.

Parameters

NodeId	Identifier of the node to remove.
OnComplete	Async callback.

◆ ResetProperty() [1/2]

virtual void FI3DHInstanceGraphAPI::ResetProperty	(	int32	NodeId,
		const FString &	Property,
		bool	bRecursive,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Resets the value of the property on the Node with the matching id.

Parameters

NodeId	The id of the Node whose property should be reset.
Property	Name of the Property which should be reset.
bRecursive	If set to true, the properties are reset recursively.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use ResetProperty(int32, EI3DHProperty, ...) or ResetPropertyByName() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ ResetProperty() [2/2]

virtual void FI3DHInstanceGraphAPI::ResetProperty	(	int32	NodeId,
		EI3DHProperty	Property,
		bool	bRecursive,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Resets the value of a property on the given node.

Parameters

NodeId	The id of the node whose property should be reset.
Property	The property which should be reset.
bRecursive	If set to true, the property is reset recursively.
OnComplete	Async callback.

◆ ResetPropertyByName()

virtual void FI3DHInstanceGraphAPI::ResetPropertyByName	(	int32	NodeId,
		const FString &	Property,
		bool	bRecursive,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Resets the value of a property on the given node.

Parameters

NodeId	The id of the node whose property should be reset.
Property	The property which should be reset.
bRecursive	If set to true, the property is reset recursively.
OnComplete	Async callback.

◆ SetPropertyB()

virtual void FI3DHInstanceGraphAPI::SetPropertyB	(	int	NodeId,
		const FString &	Property,
		bool	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Sets the value of the boolean property on the Node with the matching id to the provided value.

Parameters

NodeId	The id of the Node whose property has to be set.
Property	Name of the Property which has to be set.
Value	The new value of the specified property.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use SetPropertyBool() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ SetPropertyBool()

virtual void FI3DHInstanceGraphAPI::SetPropertyBool	(	int32	NodeId,
		EI3DHPropertyBool	Property,
		bool	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a boolean property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyBoolByName()

virtual void FI3DHInstanceGraphAPI::SetPropertyBoolByName	(	int32	NodeId,
		const FString &	Property,
		bool	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a boolean property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyEnum()

virtual void FI3DHInstanceGraphAPI::SetPropertyEnum	(	int32	NodeId,
		EI3DHPropertyEnum	Property,
		int32	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes an enum property on the given node.

If the property is known statically, prefer FI3DHInstanceGraphAPI::SetPropertyEnumTyped.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyEnumByName()

virtual void FI3DHInstanceGraphAPI::SetPropertyEnumByName	(	int32	NodeId,
		const FString &	Property,
		int32	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes an enum property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyEnumTyped()

template<EI3DHPropertyEnum Property>

void FI3DHInstanceGraphAPI::SetPropertyEnumTyped	(	int32	NodeId,
		typename TI3DHValueTypeFromEnumProperty< Property >::Value	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

inline

Writes an enum property (supplied as template argument) on the given node.

Template Parameters

Property The property which should be written.

Parameters

NodeId	The id of the node.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyI()

virtual void FI3DHInstanceGraphAPI::SetPropertyI	(	int	NodeId,
		const FString &	Property,
		int	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Sets the value of the integer property on the Node with the matching id to the provided value.

Parameters

NodeId	The id of the Node whose property has to be set.
Property	Name of the Property which has to be set.
Value	The new value of the specified property.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use SetPropertyInteger() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ SetPropertyInteger()

virtual void FI3DHInstanceGraphAPI::SetPropertyInteger	(	int32	NodeId,
		EI3DHPropertyInteger	Property,
		int32	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes an integer property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyIntegerArray()

virtual void FI3DHInstanceGraphAPI::SetPropertyIntegerArray	(	int32	NodeId,
		EI3DHPropertyIntegerArray	Property,
		const TArray< int32 > &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes an integer array property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyIntegerArrayByName()

virtual void FI3DHInstanceGraphAPI::SetPropertyIntegerArrayByName	(	int32	NodeId,
		const FString &	Property,
		const TArray< int32 > &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes an integer array property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyIntegerByName()

virtual void FI3DHInstanceGraphAPI::SetPropertyIntegerByName	(	int32	NodeId,
		const FString &	Property,
		int32	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes an integer property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyJSON()

virtual void FI3DHInstanceGraphAPI::SetPropertyJSON	(	int32	NodeId,
		EI3DHPropertyJSON	Property,
		const FString &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a property on the given node as JSON.

Works on any property. As a special case, if Value is the empty string, the property will be set to undefined.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyJSONByName()

virtual void FI3DHInstanceGraphAPI::SetPropertyJSONByName	(	int32	NodeId,
		const FString &	Property,
		const FString &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a property on the given node as JSON.

Works on any property. As a special case, if Value is the empty string, the property will be set to undefined.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyRelativeTransform()

virtual void FI3DHInstanceGraphAPI::SetPropertyRelativeTransform	(	int	NodeId,
		EI3DHTransformType	Type,
		const FMatrix &	Transform,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Set a node's local/global transform.

Global transforms are relative to the hub connector.

Parameters

NodeId	The id of the Node whose transform has to be set.
Type	The transform type defining whether the local or global transform is set.
Transform	Local or global transform.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use SetPropertyTransform() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ SetPropertyS()

virtual void FI3DHInstanceGraphAPI::SetPropertyS	(	int	NodeId,
		const FString &	Property,
		const FString &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Sets the value of the string property on the Node with the matching id to the provided value.

Parameters

NodeId	The id of the Node whose property has to be set.
Property	Name of the Property which has to be set.
Value	The new value of the specified property.
OnComplete	Async callback.

Deprecated: Deprecated in v1.0.0. "Use SetPropertyString() instead."
Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.

◆ SetPropertyString()

virtual void FI3DHInstanceGraphAPI::SetPropertyString	(	int32	NodeId,
		EI3DHPropertyString	Property,
		const FString &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a string property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyStringArray()

virtual void FI3DHInstanceGraphAPI::SetPropertyStringArray	(	int32	NodeId,
		EI3DHPropertyStringArray	Property,
		const TArray< FString > &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a string array property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyStringArrayByName()

virtual void FI3DHInstanceGraphAPI::SetPropertyStringArrayByName	(	int32	NodeId,
		const FString &	Property,
		const TArray< FString > &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a string array property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyStringByName()

virtual void FI3DHInstanceGraphAPI::SetPropertyStringByName	(	int32	NodeId,
		const FString &	Property,
		const FString &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a string property on the given node.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyTransform()

virtual void FI3DHInstanceGraphAPI::SetPropertyTransform	(	int32	NodeId,
		EI3DHPropertyTransform	Property,
		const FMatrix &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a transform property on the given node.

This function automatically converts the transform from the Unreal coordinate system, see Coordinate Systems.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyTransformByName()

virtual void FI3DHInstanceGraphAPI::SetPropertyTransformByName	(	int32	NodeId,
		const FString &	Property,
		const FMatrix &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a transform property on the given node.

This function automatically converts the transform from the Unreal coordinate system, see Coordinate Systems.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyVolume()

virtual void FI3DHInstanceGraphAPI::SetPropertyVolume	(	int32	NodeId,
		EI3DHPropertyVolume	Property,
		const FBox &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a volume property on the given node.

This function automatically converts the volume from the Unreal coordinate system, see Coordinate Systems.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

◆ SetPropertyVolumeByName()

virtual void FI3DHInstanceGraphAPI::SetPropertyVolumeByName	(	int32	NodeId,
		const FString &	Property,
		const FBox &	Value,
		TUniqueFunction< void(EI3DHErrorCode ErrorCode)>	OnComplete )

pure virtual

Writes a volume property on the given node.

This function automatically converts the volume from the Unreal coordinate system, see Coordinate Systems.

Parameters

NodeId	The id of the node.
Property	The property which should be written.
Value	The new value of the property.
OnComplete	Async callback.

InstanceGraph API

Detailed Description

Classes

Functions

Function Documentation

◆ AddResource()

◆ GetGlobalRootNodeId() [1/2]

◆ GetGlobalRootNodeId() [2/2]

◆ GetPropertyB()

◆ GetPropertyBool()

◆ GetPropertyBoolByName()

◆ GetPropertyEnum()

◆ GetPropertyEnumByName()

◆ GetPropertyEnumTyped()

◆ GetPropertyI()

◆ GetPropertyIA()

◆ GetPropertyInteger()

◆ GetPropertyIntegerArray()

◆ GetPropertyIntegerArrayByName()

◆ GetPropertyIntegerByName()

◆ GetPropertyJSON()

◆ GetPropertyJSONByName()

◆ GetPropertyRelativeTransform()

◆ GetPropertyS()

◆ GetPropertyString()

◆ GetPropertyStringArray()

◆ GetPropertyStringArrayByName()

◆ GetPropertyStringByName()

◆ GetPropertyTransform()

◆ GetPropertyTransformByName()

◆ GetPropertyVolume()

◆ GetPropertyVolumeByName()

◆ RemoveResource()

◆ ResetProperty() [1/2]

◆ ResetProperty() [2/2]

◆ ResetPropertyByName()

◆ SetPropertyB()

◆ SetPropertyBool()

◆ SetPropertyBoolByName()

◆ SetPropertyEnum()

◆ SetPropertyEnumByName()

◆ SetPropertyEnumTyped()

◆ SetPropertyI()

◆ SetPropertyInteger()

◆ SetPropertyIntegerArray()

◆ SetPropertyIntegerArrayByName()

◆ SetPropertyIntegerByName()

◆ SetPropertyJSON()

◆ SetPropertyJSONByName()

◆ SetPropertyRelativeTransform()

◆ SetPropertyS()

◆ SetPropertyString()

◆ SetPropertyStringArray()

◆ SetPropertyStringArrayByName()

◆ SetPropertyStringByName()

◆ SetPropertyTransform()

◆ SetPropertyTransformByName()

◆ SetPropertyVolume()

◆ SetPropertyVolumeByName()