General utils. More...

#include <RRGeneralUtils.h>

Inheritance diagram for URRGeneralUtils:

Collaboration diagram for URRGeneralUtils:

Static Public Member Functions
template<typename T >
static T *	FindActorByName (UWorld *InWorld, const FString &InName, const ESearchCase::Type InCaseType=ESearchCase::IgnoreCase)
	Find actor by name. GetAllActors() is expensive. More...

static AActor *	FindActorByName (const UObject *WorldContextObject, const FString &InName, const ESearchCase::Type InCaseType=ESearchCase::IgnoreCase)
	Blueprint Callable, non template version of FindActorByName. More...

template<typename T >
static T *	FindActorBySubname (UWorld *InWorld, const FString &InSubname, const ESearchCase::Type InCaseType=ESearchCase::IgnoreCase)
	Find actor by subname. search actor whose name contains InSubname. More...

static AActor *	FindActorBySubname (const UObject *WorldContextObject, const FString &InSubname, const ESearchCase::Type InCaseType=ESearchCase::IgnoreCase)
	Blueprint Callable, non template version of FindActorBySubname. More...

template<typename T >
static TArray< T * >	FindActorListBySubname (UWorld *InWorld, const FString &InSubname, const ESearchCase::Type InCaseType=ESearchCase::IgnoreCase)

static TArray< AActor * >	FindActorListBySubname (const UObject *WorldContextObject, const FString &InSubname, const ESearchCase::Type InCaseType=ESearchCase::IgnoreCase)

static bool	GetRefTransform (const AActor *RefActor, FTransform &OutTransf, const bool ReturnIdentityWithNullptr=true, const bool Verbose=false)
	Get the Ref Transform. More...

static bool	GetRefTransform (const FString &RefActorName, const AActor RefActor, const UObject WorldContextObject, FTransform &OutTransf, const bool Verbose=false)
	Get the Ref Transform. If RefActor==nullptr, search actor from RefActorName. If no actor is found, return false and OutTransf = FTransform::Identity. More...

static bool	GetRefTransformByActor (const AActor *RefActor, FTransform &OutTransf, const bool Verbose=false)
	Get the Ref Transform. If RefActor==nullptr, OutTransf = FTransform::Identity. More...

static bool	GetRefTransformByName (const FString &RefActorName, const UObject *WorldContextObject, FTransform &OutTransf, const bool Verbose=false)
	Get the Ref Transform. Search actor from name. If no actor is found, return false and OutTransf = FTransform::Identity. More...

static FTransform	GetRelativeTransform (const FTransform &RefTransf, const FTransform &WorldTransf, const bool IgnoreScale=false)
	Get the transform in reference frame. More...

static FTransform	GetRelativeTransform (const AActor *RefActor, const FTransform &WorldTransf, const bool IgnoreScale=false, const bool Verbose=false)
	Get the transform in reference frame. If RefActor==nullptr, return WorldTransf. More...

static FTransform	GetRelativeTransform (const FString &RefActorName, const UObject *WorldContextObject, const FTransform &WorldTransf, const bool IgnoreScale=false, const bool Verbose=false)
	Get the transform in reference frame. If Actor with given name is not exists, return WorldTransf. More...

static FTransform	GetRelativeTransformFromActor (const AActor *RefActor, const FTransform &WorldTransf, const bool IgnoreScale=false, const bool Verbose=false)
	Blueprint wrapper for GetRelativeTransform. More...

static FTransform	GetRelativeTransformFromName (const FString &RefActorName, const UObject *WorldContextObject, const FTransform &WorldTransf, const bool IgnoreScale=false, const bool Verbose=false)
	Blueprint wrapper for GetRelativeTransform. More...

static bool	GetRelativeTransform (const AActor *RefActor, const FTransform &InTransf, FTransform &OutTransf, const bool IgnoreScale=false, const bool ReturnIdentityWithNullptr=true, const bool Verbose=false)
	Get the transform in reference frame. More...

static bool	GetRelativeTransform (const FString &RefActorName, const AActor RefActor, const FTransform &InTransf, const UObject WorldContextObject, FTransform &OutTransf, const bool IgnoreScale=false, const bool Verbose=false)
	Get the transform in reference frame. More...

static FTransform	GetWorldTransform (const FTransform &RefTransf, const FTransform &RelativeTransf, const bool IgnoreScale=false)
	Get the transform in world frame. More...

static FTransform	GetWorldTransform (const AActor *RefActor, const FTransform &RelativeTransf, const bool IgnoreScale=false, const bool Verbose=false)
	Get the transform in world frame. If RefActor==nullptr, return RelativeTransf. More...

static FTransform	GetWorldTransform (const FString &RefActorName, const UObject *WorldContextObject, const FTransform &RelativeTransf, const bool IgnoreScale=false, const bool Verbose=false)
	Get the transform in world frame. If RefActor==nullptr, return RelativeTransf. More...

static FTransform	GetWorldTransformFromActor (const AActor *RefActor, const FTransform &RelativeTransf, const bool IgnoreScale=false, const bool Verbose=false)
	Blueprint wrapper for GetRelativeTransform. More...

static FTransform	GetWorldTransformFromName (const FString &RefActorName, const UObject *WorldContextObject, const FTransform &RelativeTransf, const bool IgnoreScale=false, const bool Verbose=false)
	Blueprint wrapper for GetRelativeTransform. More...

static bool	GetWorldTransform (const AActor *RefActor, const FTransform &InTransf, FTransform &OutTransf, const bool ReturnIdentityWithNullptr=true, const bool IgnoreScale=false, const bool Verbose=false)
	Get the transform in world frame. More...

static bool	GetWorldTransform (const FString &RefActorName, const AActor RefActor, const FTransform &InTransf, const UObject WorldContextObject, FTransform &OutTransf, const bool IgnoreScale=false)
	Get the transform in world frame. More...

static FORCEINLINE FString	GetNewROS2NodeName (const FString &InAffix=FString())
	Create Unique name start with UE + InAffix_ + Guid. More...

static FORCEINLINE FString	ComposeROSFullFrameId (const FString &InPrefix, const TCHAR *InFrameId)
	Create prefixed frame_id. More...

static FORCEINLINE bool	GetJsonField (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, FString &OutValue)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

static FORCEINLINE bool	GetJsonField (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, float &OutValue, float InMultiplier=1.f)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

static FORCEINLINE bool	GetJsonField (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, double &OutValue, double InMultiplier=1.)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

static FORCEINLINE bool	GetJsonField (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, int &OutValue)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

static FORCEINLINE bool	GetJsonField (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, bool &OutValue)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

static FORCEINLINE bool	GetJsonField (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, FVector &OutValue)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

static FORCEINLINE bool	GetJsonField (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, FRotator &OutValue)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

static FORCEINLINE bool	GetJsonField (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, FQuat &OutValue)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

static FORCEINLINE bool	GetJsonField (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, FTransform &OutValue)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

template<typename T >
static bool	GetJsonField (const FString &InJsonString, const FString &InFieldName, T &OutValue)
	template wrapper of GetJsonField. More...

static bool	GetJsonFieldVector (const FString &InJsonString, const FString &InFieldName, FVector &OutValue)
	Blueprint wrapper of GetJsonField. More...

static bool	GetJsonFieldRotator (const FString &InJsonString, const FString &InFieldName, FRotator &OutValue)
	Blueprint wrapper of GetJsonField. More...

static bool	GetJsonFieldQuat (const FString &InJsonString, const FString &InFieldName, FQuat &OutValue)
	Blueprint wrapper of GetJsonField. More...

static bool	GetJsonFieldTransform (const FString &InJsonString, const FString &InFieldName, FTransform &OutValue)
	Blueprint wrapper of GetJsonField. More...

template<typename T >
static FORCEINLINE bool	GetJsonFieldOrDefault (const TSharedPtr< FJsonObject > &InJsonObj, const FString &InFieldName, const T &InDefaultValue, T &OutValue)
	Initialize OutValue with the value of the requested field in a FJsonObject. More...

static UPrimitiveComponent *	GetComponentOfActorFromName (const AActor *Actor, FName ComponentName)
	Get the component of actor from component name. More...

static UPrimitiveComponent *	GetPhysicsConstraintComponent (const UPhysicsConstraintComponent *InConstraint, EConstraintFrame::Type Frame)
	Get the Physics Constraint Component. More...

static FTransform	GetPhysicsConstraintTransform (const UPhysicsConstraintComponent InConstraint, const FTransform InitialJointToChildLink, UPrimitiveComponent InChildLink=nullptr)
	Get the Physics Constraint Transform changes from initial joint transform, i.e. child link transfrom relative to joint. More...

static void	GetPhysicsConstraintTransform (const UPhysicsConstraintComponent InConstraint, const FTransform InitialJointToChildLink, FVector &OutPosition, FRotator &OutOrientation, UPrimitiveComponent InChildLink=nullptr)
	Get the Physics Constraint Transform. More...

static FString	PascalToSnake (const FString &InPascalString, const bool InCheckNum=false)

static USceneComponent *	FindChildComponentByClass (const USceneComponent *InTarget, const TSubclassOf< UActorComponent > InComponentClass, bool bIncludeAllDescendants=false)

Detailed Description

General utils.

UCLASS()

Member Function Documentation

◆ ComposeROSFullFrameId()

static FORCEINLINE FString URRGeneralUtils::ComposeROSFullFrameId	(	const FString &	InPrefix,
		const TCHAR *	InFrameId
	)

inlinestatic

Create prefixed frame_id.

Parameters

InPrefix
InFrameId

Returns: FString prefixed frame_id

◆ FindActorByName() [1/2]

static AActor* URRGeneralUtils::FindActorByName	(	const UObject *	WorldContextObject,
		const FString &	InName,
		const ESearchCase::Type	InCaseType = `ESearchCase::IgnoreCase`
	)

inlinestatic

Blueprint Callable, non template version of FindActorByName.

Parameters

WorldContextObject
InName
InCaseType

Returns: AActor*

UFUNCTION(BlueprintCallable, meta = (WorldContext = WorldContextObject))

◆ FindActorByName() [2/2]

template<typename T >

static T* URRGeneralUtils::FindActorByName	(	UWorld *	InWorld,
		const FString &	InName,
		const ESearchCase::Type	InCaseType = `ESearchCase::IgnoreCase`
	)

inlinestatic

Find actor by name. GetAllActors() is expensive.

Template Parameters

T

Parameters

InWorld
InName
InCaseType

Returns: T*

◆ FindActorBySubname() [1/2]

static AActor* URRGeneralUtils::FindActorBySubname	(	const UObject *	WorldContextObject,
		const FString &	InSubname,
		const ESearchCase::Type	InCaseType = `ESearchCase::IgnoreCase`
	)

inlinestatic

Blueprint Callable, non template version of FindActorBySubname.

Parameters

WorldContextObject
InSubname
InCaseType

Returns: AActor*

UFUNCTION(BlueprintCallable, meta = (WorldContext = WorldContextObject))

◆ FindActorBySubname() [2/2]

template<typename T >

static T* URRGeneralUtils::FindActorBySubname	(	UWorld *	InWorld,
		const FString &	InSubname,
		const ESearchCase::Type	InCaseType = `ESearchCase::IgnoreCase`
	)

inlinestatic

Find actor by subname. search actor whose name contains InSubname.

Template Parameters

T

Parameters

InWorld
InSubname
InCaseType

Returns: T*

◆ FindActorListBySubname() [1/2]

static TArray<AActor*> URRGeneralUtils::FindActorListBySubname	(	const UObject *	WorldContextObject,
		const FString &	InSubname,
		const ESearchCase::Type	InCaseType = `ESearchCase::IgnoreCase`
	)

inlinestatic

UFUNCTION(BlueprintCallable, meta = (WorldContext = WorldContextObject))

◆ FindActorListBySubname() [2/2]

template<typename T >

static TArray<T*> URRGeneralUtils::FindActorListBySubname	(	UWorld *	InWorld,
		const FString &	InSubname,
		const ESearchCase::Type	InCaseType = `ESearchCase::IgnoreCase`
	)

inlinestatic

◆ FindChildComponentByClass()

static USceneComponent* URRGeneralUtils::FindChildComponentByClass	(	const USceneComponent *	InTarget,
		const TSubclassOf< UActorComponent >	InComponentClass,
		bool	bIncludeAllDescendants = `false`
	)

inlinestatic

UFUNCTION(BlueprintCallable, BlueprintPure)

◆ GetComponentOfActorFromName()

static UPrimitiveComponent* URRGeneralUtils::GetComponentOfActorFromName	(	const AActor *	Actor,
		FName	ComponentName
	)

inlinestatic

Get the component of actor from component name.

Parameters

Actor
ComponentName

Returns: UPrimitiveComponent*

UFUNCTION(BlueprintCallable)

◆ GetJsonField() [1/10]

template<typename T >

static bool URRGeneralUtils::GetJsonField	(	const FString &	InJsonString,
		const FString &	InFieldName,
		T &	OutValue
	)

inlinestatic

template wrapper of GetJsonField.

Template Parameters

T

Parameters

InJsonString	the Json string containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

◆ GetJsonField() [2/10]

static FORCEINLINE bool URRGeneralUtils::GetJsonField	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		bool &	OutValue
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

◆ GetJsonField() [3/10]

static FORCEINLINE bool URRGeneralUtils::GetJsonField	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		double &	OutValue,
		double	InMultiplier = `1.`
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value
InMultiplier	(optional) returned value is multiplied by this. Set to 1.f by default

Returns: bool if the field exists in the Json object

◆ GetJsonField() [4/10]

static FORCEINLINE bool URRGeneralUtils::GetJsonField	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		float &	OutValue,
		float	InMultiplier = `1.f`
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value
InMultiplier	(optional) returned value is multiplied by this. Set to 1.f by default

Returns: bool if the field exists in the Json object

◆ GetJsonField() [5/10]

static FORCEINLINE bool URRGeneralUtils::GetJsonField	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		FQuat &	OutValue
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

◆ GetJsonField() [6/10]

static FORCEINLINE bool URRGeneralUtils::GetJsonField	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		FRotator &	OutValue
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

◆ GetJsonField() [7/10]

static FORCEINLINE bool URRGeneralUtils::GetJsonField	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		FString &	OutValue
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

◆ GetJsonField() [8/10]

static FORCEINLINE bool URRGeneralUtils::GetJsonField	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		FTransform &	OutValue
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

◆ GetJsonField() [9/10]

static FORCEINLINE bool URRGeneralUtils::GetJsonField	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		FVector &	OutValue
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

◆ GetJsonField() [10/10]

static FORCEINLINE bool URRGeneralUtils::GetJsonField	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		int &	OutValue
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

◆ GetJsonFieldOrDefault()

template<typename T >

static FORCEINLINE bool URRGeneralUtils::GetJsonFieldOrDefault	(	const TSharedPtr< FJsonObject > &	InJsonObj,
		const FString &	InFieldName,
		const T &	InDefaultValue,
		T &	OutValue
	)

inlinestatic

Initialize OutValue with the value of the requested field in a FJsonObject.

If the field does not exist, OutValue = InDefaultValue

Parameters

InJsonObj	the Json object containing the required field
InFieldName	the name of the field to read
InDefaultValue	the value sent back if the field is not in the Json object
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

◆ GetJsonFieldQuat()

static bool URRGeneralUtils::GetJsonFieldQuat	(	const FString &	InJsonString,
		const FString &	InFieldName,
		FQuat &	OutValue
	)

inlinestatic

Blueprint wrapper of GetJsonField.

Todo:: Use K2_Node

Parameters

InJsonString	the Json string containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

UFUNCTION(BlueprintCallable)

◆ GetJsonFieldRotator()

static bool URRGeneralUtils::GetJsonFieldRotator	(	const FString &	InJsonString,
		const FString &	InFieldName,
		FRotator &	OutValue
	)

inlinestatic

Blueprint wrapper of GetJsonField.

Todo:: Use K2_Node

Parameters

InJsonString	the Json string containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

UFUNCTION(BlueprintCallable)

◆ GetJsonFieldTransform()

static bool URRGeneralUtils::GetJsonFieldTransform	(	const FString &	InJsonString,
		const FString &	InFieldName,
		FTransform &	OutValue
	)

inlinestatic

Blueprint wrapper of GetJsonField.

Todo:: Use K2_Node

Parameters

InJsonString	the Json string containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

UFUNCTION(BlueprintCallable)

◆ GetJsonFieldVector()

static bool URRGeneralUtils::GetJsonFieldVector	(	const FString &	InJsonString,
		const FString &	InFieldName,
		FVector &	OutValue
	)

inlinestatic

Blueprint wrapper of GetJsonField.

Todo:: Use K2_Node

Parameters

InJsonString	the Json string containing the required field
InFieldName	the name of the field to read
OutValue	contains the returned value

Returns: bool if the field exists in the Json object

UFUNCTION(BlueprintCallable)

◆ GetNewROS2NodeName()

static FORCEINLINE FString URRGeneralUtils::GetNewROS2NodeName ( const FString & InAffix = FString() )

inlinestatic

Create Unique name start with UE + InAffix_ + Guid.

Parameters

InAffix

Returns: FString Unique name

◆ GetPhysicsConstraintComponent()

static UPrimitiveComponent* URRGeneralUtils::GetPhysicsConstraintComponent	(	const UPhysicsConstraintComponent *	InConstraint,
		EConstraintFrame::Type	Frame
	)

inlinestatic

Get the Physics Constraint Component.

See also: EConstraintFrame

Parameters

InConstraint
Frame

Returns: UPrimitiveComponent*

UFUNCTION(BlueprintCallable)

◆ GetPhysicsConstraintTransform() [1/2]

static void URRGeneralUtils::GetPhysicsConstraintTransform	(	const UPhysicsConstraintComponent *	InConstraint,
		const FTransform	InitialJointToChildLink,
		FVector &	OutPosition,
		FRotator &	OutOrientation,
		UPrimitiveComponent *	InChildLink = `nullptr`
	)

inlinestatic

Get the Physics Constraint Transform.

Parameters

InConstraint
InitialJointToChildLink
OutPosition
OutOrientation
InChildLink

◆ GetPhysicsConstraintTransform() [2/2]

static FTransform URRGeneralUtils::GetPhysicsConstraintTransform	(	const UPhysicsConstraintComponent *	InConstraint,
		const FTransform	InitialJointToChildLink,
		UPrimitiveComponent *	InChildLink = `nullptr`
	)

inlinestatic

Get the Physics Constraint Transform changes from initial joint transform, i.e. child link transfrom relative to joint.

Parameters

InConstraint
InitialJointToChildLink
InChildLink

Returns: FTransform

UFUNCTION(BlueprintCallable)

◆ GetRefTransform() [1/2]

static bool URRGeneralUtils::GetRefTransform	(	const AActor *	RefActor,
		FTransform &	OutTransf,
		const bool	ReturnIdentityWithNullptr = `true`,
		const bool	Verbose = `false`
	)

inlinestatic

Get the Ref Transform.

Parameters

RefActor	Reference Actor
OutTransf	Transform of RefActor or Identity.
ReturnIdentityWithNullptr	If this is true, return true and OutTransf = FTransform::Identity with nullptr RefActor.
Verbose

Returns: true; false

◆ GetRefTransform() [2/2]

static bool URRGeneralUtils::GetRefTransform	(	const FString &	RefActorName,
		const AActor *	RefActor,
		const UObject *	WorldContextObject,
		FTransform &	OutTransf,
		const bool	Verbose = `false`
	)

inlinestatic

Get the Ref Transform. If RefActor==nullptr, search actor from RefActorName. If no actor is found, return false and OutTransf = FTransform::Identity.

If RefActor==nullptr && RefActorName==Empty, return true and OutTransf = FTransform::Identity

Parameters

RefActorName
RefActor
InWorld
OutTransf
Verbose

Returns: true; false

UFUNCTION(BlueprintCallable, meta = (WorldContext = WorldContextObject))

◆ GetRefTransformByActor()

static bool URRGeneralUtils::GetRefTransformByActor	(	const AActor *	RefActor,
		FTransform &	OutTransf,
		const bool	Verbose = `false`
	)

inlinestatic

Get the Ref Transform. If RefActor==nullptr, OutTransf = FTransform::Identity.

Parameters

RefActor
OutTransf
Verbose

Returns: true; false

UFUNCTION(BlueprintCallable)

◆ GetRefTransformByName()

static bool URRGeneralUtils::GetRefTransformByName	(	const FString &	RefActorName,
		const UObject *	WorldContextObject,
		FTransform &	OutTransf,
		const bool	Verbose = `false`
	)

inlinestatic

Get the Ref Transform. Search actor from name. If no actor is found, return false and OutTransf = FTransform::Identity.

Parameters

RefActorName
WorldContextObject
OutTransf
Verbose

Returns: true; false

UFUNCTION(BlueprintCallable, meta = (WorldContext = WorldContextObject))

◆ GetRelativeTransform() [1/5]

static bool URRGeneralUtils::GetRelativeTransform	(	const AActor *	RefActor,
		const FTransform &	InTransf,
		FTransform &	OutTransf,
		const bool	IgnoreScale = `false`,
		const bool	ReturnIdentityWithNullptr = `true`,
		const bool	Verbose = `false`
	)

inlinestatic

Get the transform in reference frame.

Parameters

RefActor	Reference Actor
InTransf
OutTransf	Transform of RefActor or Identity.
IgnoreScale
ReturnIdentityWithNullptr	if this is true, return true and OutTransf = FTransform::Identity with nullptr RefActor.
Verbose

Returns: true; false

◆ GetRelativeTransform() [2/5]

static FTransform URRGeneralUtils::GetRelativeTransform	(	const AActor *	RefActor,
		const FTransform &	WorldTransf,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Get the transform in reference frame. If RefActor==nullptr, return WorldTransf.

Parameters

RefActor
WorldTransf	Transform in world frame
IgnoreScale
Verbose

Returns: FTransform Transform in reference frame

◆ GetRelativeTransform() [3/5]

static bool URRGeneralUtils::GetRelativeTransform	(	const FString &	RefActorName,
		const AActor *	RefActor,
		const FTransform &	InTransf,
		const UObject *	WorldContextObject,
		FTransform &	OutTransf,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Get the transform in reference frame.

Parameters

RefActorName	If this is empty, use world origin as reference, i.e. OutTransf=InTransf
RefActor	If this is nullptr, return false.
InTransf	Transform in world frame
OutTransf	Transform in reference frame

Returns: true; false

◆ GetRelativeTransform() [4/5]

static FTransform URRGeneralUtils::GetRelativeTransform	(	const FString &	RefActorName,
		const UObject *	WorldContextObject,
		const FTransform &	WorldTransf,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Get the transform in reference frame. If Actor with given name is not exists, return WorldTransf.

Parameters

RefActorName
WorldContextObject
WorldTransf	Transform in world frame
IgnoreScale
Verbose

Returns: FTransform Transform in reference frame

◆ GetRelativeTransform() [5/5]

static FTransform URRGeneralUtils::GetRelativeTransform	(	const FTransform &	RefTransf,
		const FTransform &	WorldTransf,
		const bool	IgnoreScale = `false`
	)

inlinestatic

Get the transform in reference frame.

Parameters

RefTransf	Reference frame
WorldTransf	Transform in world frame
IgnoreScale

Returns: FTransform Transform in reference frame

UFUNCTION(BlueprintCallable)

◆ GetRelativeTransformFromActor()

static FTransform URRGeneralUtils::GetRelativeTransformFromActor	(	const AActor *	RefActor,
		const FTransform &	WorldTransf,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Blueprint wrapper for GetRelativeTransform.

Parameters

RefActor
WorldTransf	Transform in world frame
IgnoreScale
Verbose

Returns: FTransform Transform in reference frame

UFUNCTION(BlueprintCallable)

◆ GetRelativeTransformFromName()

static FTransform URRGeneralUtils::GetRelativeTransformFromName	(	const FString &	RefActorName,
		const UObject *	WorldContextObject,
		const FTransform &	WorldTransf,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Blueprint wrapper for GetRelativeTransform.

Parameters

RefActor
WorldContextObject
WorldTransf	Transform in world frame
IgnoreScale
Verbose

Returns: FTransform Transform in reference frame

UFUNCTION(BlueprintCallable, meta = (WorldContext = WorldContextObject))

◆ GetWorldTransform() [1/5]

static bool URRGeneralUtils::GetWorldTransform	(	const AActor *	RefActor,
		const FTransform &	InTransf,
		FTransform &	OutTransf,
		const bool	ReturnIdentityWithNullptr = `true`,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Get the transform in world frame.

Parameters

RefActorName	If this is empty, use world origin as reference, i.e. OutTransf=InTransf
RefActor	If this is nullptr, return false.
InTransf	Transform in reference frame
OutTransf	Transform in world frame
ReturnIdentityWithNullptr
IgnoreScale
Verbose

Returns: true; false

◆ GetWorldTransform() [2/5]

static FTransform URRGeneralUtils::GetWorldTransform	(	const AActor *	RefActor,
		const FTransform &	RelativeTransf,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Get the transform in world frame. If RefActor==nullptr, return RelativeTransf.

Parameters

RefActor
RelativeTransf	Transform in reference frame
IgnoreScale
Verbose

Returns: FTransform Transform in world frame

◆ GetWorldTransform() [3/5]

static bool URRGeneralUtils::GetWorldTransform	(	const FString &	RefActorName,
		const AActor *	RefActor,
		const FTransform &	InTransf,
		const UObject *	WorldContextObject,
		FTransform &	OutTransf,
		const bool	IgnoreScale = `false`
	)

inlinestatic

Get the transform in world frame.

Parameters

RefActorName	If this is empty, use world origin as reference, i.e. OutTransf=InTransf
RefActor	If this is nullptr, return false.
InTransf	Transform in reference frame
OutTransf	Transform in world frame
IgnoreScale

Returns: true; false

◆ GetWorldTransform() [4/5]

static FTransform URRGeneralUtils::GetWorldTransform	(	const FString &	RefActorName,
		const UObject *	WorldContextObject,
		const FTransform &	RelativeTransf,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Get the transform in world frame. If RefActor==nullptr, return RelativeTransf.

Parameters

RefActorName
WorldContextObject
RefActor
RelativeTransf	Transform in reference frame
IgnoreScale
Verbose

Returns: FTransform Transform in world frame

◆ GetWorldTransform() [5/5]

static FTransform URRGeneralUtils::GetWorldTransform	(	const FTransform &	RefTransf,
		const FTransform &	RelativeTransf,
		const bool	IgnoreScale = `false`
	)

inlinestatic

Get the transform in world frame.

Parameters

RefTransf	Reference frame
RelativeTransf	Transform in reference frame
IgnoreScale

Returns: FTransform Transform in world frame

UFUNCTION(BlueprintCallable, meta = (WorldContext = WorldContextObject))

◆ GetWorldTransformFromActor()

static FTransform URRGeneralUtils::GetWorldTransformFromActor	(	const AActor *	RefActor,
		const FTransform &	RelativeTransf,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Blueprint wrapper for GetRelativeTransform.

Parameters

RefActor
RelativeTransf	Transform in reference frame
IgnoreScale
Verbose

Returns: FTransform Transform in world frame

UFUNCTION(BlueprintCallable)

◆ GetWorldTransformFromName()

static FTransform URRGeneralUtils::GetWorldTransformFromName	(	const FString &	RefActorName,
		const UObject *	WorldContextObject,
		const FTransform &	RelativeTransf,
		const bool	IgnoreScale = `false`,
		const bool	Verbose = `false`
	)

inlinestatic

Blueprint wrapper for GetRelativeTransform.

Parameters

RefActorName
WorldContextObject
RelativeTransf	Transform in reference frame
IgnoreScale
Verbose

Returns: FTransform Transform in world frame

UFUNCTION(BlueprintCallable, meta = (WorldContext = WorldContextObject))

◆ PascalToSnake()

static FString URRGeneralUtils::PascalToSnake	(	const FString &	InPascalString,
		const bool	InCheckNum = `false`
	)

inlinestatic

UFUNCTION(BlueprintCallable, BlueprintPure)

The documentation for this class was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/rapyutasimulationplugins/checkouts/devel/Source/RapyutaSimulationPlugins/Public/Core/RRGeneralUtils.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ComposeROSFullFrameId()

◆ FindActorByName() [1/2]

◆ FindActorByName() [2/2]

◆ FindActorBySubname() [1/2]

◆ FindActorBySubname() [2/2]

◆ FindActorListBySubname() [1/2]

◆ FindActorListBySubname() [2/2]

◆ FindChildComponentByClass()

◆ GetComponentOfActorFromName()

◆ GetJsonField() [1/10]

◆ GetJsonField() [2/10]

◆ GetJsonField() [3/10]

◆ GetJsonField() [4/10]

◆ GetJsonField() [5/10]

◆ GetJsonField() [6/10]

◆ GetJsonField() [7/10]

◆ GetJsonField() [8/10]

◆ GetJsonField() [9/10]

◆ GetJsonField() [10/10]

◆ GetJsonFieldOrDefault()

◆ GetJsonFieldQuat()

◆ GetJsonFieldRotator()

◆ GetJsonFieldTransform()

◆ GetJsonFieldVector()

◆ GetNewROS2NodeName()

◆ GetPhysicsConstraintComponent()

◆ GetPhysicsConstraintTransform() [1/2]

◆ GetPhysicsConstraintTransform() [2/2]

◆ GetRefTransform() [1/2]

◆ GetRefTransform() [2/2]

◆ GetRefTransformByActor()

◆ GetRefTransformByName()

◆ GetRelativeTransform() [1/5]

◆ GetRelativeTransform() [2/5]

◆ GetRelativeTransform() [3/5]

◆ GetRelativeTransform() [4/5]

◆ GetRelativeTransform() [5/5]

◆ GetRelativeTransformFromActor()

◆ GetRelativeTransformFromName()

◆ GetWorldTransform() [1/5]

◆ GetWorldTransform() [2/5]

◆ GetWorldTransform() [3/5]

◆ GetWorldTransform() [4/5]

◆ GetWorldTransform() [5/5]

◆ GetWorldTransformFromActor()

◆ GetWorldTransformFromName()

◆ PascalToSnake()