UserInterfaceHelperFunctions Namespace Reference

Enumerations
enum	EImageSize { Small , Medium , Large }

Functions
const ARTICYEDITOR_API FSlateBrush *	GetArticyTypeImage (const UArticyObject *ArticyObject, EImageSize Size)
ARTICYEDITOR_API UTexture2D *	GetDisplayImage (const UArticyObject *ArticyObject)
ARTICYEDITOR_API bool	RetrievePreviewImage (const UArticyObject *ArticyObject, FSlateBrush &OutSlateBrush)
ARTICYEDITOR_API bool	RetrieveSpeakerPreviewImage (const UArticyObject *ArticyObject, FSlateBrush &OutSlateBrush)
const ARTICYEDITOR_API FArticyId *	GetTargetID (const UArticyObject *ArticyObject)
const ARTICYEDITOR_API FString	GetDisplayName (const UArticyObject *ArticyObject)
const ARTICYEDITOR_API FLinearColor	GetColor (const UArticyObject *ArticyObject)
const ARTICYEDITOR_API bool	ShowObjectInArticy (const UArticyObject *ArticyObject)
const ARTICYEDITOR_API bool	ShowObjectInArticy (const FArticyId ArticyId, bool bNewTab)

Detailed Description

A namespace containing utility functions for handling user interface elements related to Articy objects.

Enumeration Type Documentation

EImageSize

enum UserInterfaceHelperFunctions::EImageSize

Enumeration representing the possible sizes for images.

Function Documentation

GetArticyTypeImage()

const FSlateBrush * UserInterfaceHelperFunctions::GetArticyTypeImage	(	const UArticyObject *	ArticyObject,
		UserInterfaceHelperFunctions::EImageSize	Size )

Retrieves the type image associated with an Articy object based on its type and specified size.

Parameters

ArticyObject	The Articy object for which to retrieve the type image.
Size	The desired size of the image (Small, Medium, or Large).

Returns

The Slate brush representing the type image for the specified Articy object.

GetColor()

const FLinearColor UserInterfaceHelperFunctions::GetColor

(

const UArticyObject *

ArticyObject

)

Retrieves the color associated with an Articy object.

Parameters

ArticyObject

The Articy object for which to retrieve the color.

Returns

The linear color associated with the specified Articy object.

GetDisplayImage()

UTexture2D * UserInterfaceHelperFunctions::GetDisplayImage

(

const UArticyObject *

ArticyObject

)

Retrieves the display image (preview image) associated with an Articy object.

Parameters

ArticyObject

The Articy object for which to retrieve the display image.

Returns

The texture representing the display image for the specified Articy object.

GetDisplayName()

const FString UserInterfaceHelperFunctions::GetDisplayName

(

const UArticyObject *

ArticyObject

)

Retrieves the display name associated with an Articy object.

Parameters

ArticyObject

The Articy object for which to retrieve the display name.

Returns

The string representing the display name for the specified Articy object.

GetTargetID()

const FArticyId * UserInterfaceHelperFunctions::GetTargetID

(

const UArticyObject *

ArticyObject

)

Retrieves the target ID associated with an Articy object.

Parameters

ArticyObject

The Articy object for which to retrieve the target ID.

Returns

A pointer to the target ID associated with the specified Articy object.

RetrievePreviewImage()

bool UserInterfaceHelperFunctions::RetrievePreviewImage	(	const UArticyObject *	ArticyObject,
		FSlateBrush &	OutSlateBrush )

Retrieves the preview image associated with an Articy object and assigns it to the specified Slate brush.

Parameters

ArticyObject	The Articy object for which to retrieve the preview image.
OutSlateBrush	The Slate brush to which the preview image will be assigned.

Returns

True if a preview image was successfully retrieved and assigned; otherwise, false.

RetrieveSpeakerPreviewImage()

bool UserInterfaceHelperFunctions::RetrieveSpeakerPreviewImage	(	const UArticyObject *	ArticyObject,
		FSlateBrush &	OutSlateBrush )

Retrieves the preview image associated with the speaker of an Articy object and assigns it to the specified Slate brush.

Parameters

ArticyObject	The Articy object for which to retrieve the speaker's preview image.
OutSlateBrush	The Slate brush to which the speaker's preview image will be assigned.

Returns

True if a speaker's preview image was successfully retrieved and assigned; otherwise, false.

ShowObjectInArticy() [1/2]

const bool UserInterfaceHelperFunctions::ShowObjectInArticy	(	const FArticyId	ArticyId,
		bool	bNewTab )

Displays an Articy object with the specified ID in the Articy software.

Parameters

ArticyId	The ID of the Articy object to be displayed.
bNewTab	Specifies whether to open the object in a new tab (true) or the current tab (false).

Returns

True if the Articy object was successfully displayed; otherwise, false.

ShowObjectInArticy() [2/2]

const bool UserInterfaceHelperFunctions::ShowObjectInArticy

(

const UArticyObject *

ArticyObject

)

Displays an Articy object in the Articy software.

Parameters

ArticyObject

The Articy object to be displayed.

Returns

True if the Articy object was successfully displayed; otherwise, false.