Skip to content

Struct FDictPoint

Struct FDictPoint

  • Defined in File DictPoint.h

Inheritance Relationships

Base Type

struct FDictPoint : public FPoint

Source: Source/Schola/Public/Common/Points/DictPoint.h

Dependencies: ConstPointVisitor, FPoint, PointVisitor

A dictionary of named points.

This structure stores multiple points indexed by string keys, allowing for complex hierarchical data structures. Useful for representing observations or actions that have multiple named components.


Public Functions

SymbolDetails
FDictPointConstructs an empty dictionary of points.
FDictPointConstructs a dictionary from an existing map of points.
~FDictPointVirtual destructor.
FDictPointConstructs a dictionary from an initializer list of key-value pairs.
AcceptAccepts a mutable visitor for the visitor pattern.
AcceptAccepts a const visitor for the visitor pattern.
ResetResets the dictionary, removing all points.
ToStringConverts this dictionary point to a string representation.

FDictPoint

inline FDictPoint()

Constructs an empty dictionary of points.

Attributes: inline

Source: Source/Schola/Public/Common/Points/DictPoint.h

FDictPoint

inline FDictPoint(const TMap<FString, TInstancedStruct<FPoint>> &InPoints)

Constructs a dictionary from an existing map of points.

Parameters

InPoints – [in] The map of string keys to points to initialize with.

Attributes: inline

Source: Source/Schola/Public/Common/Points/DictPoint.h


~FDictPoint

inline virtual ~FDictPoint()

Virtual destructor.

Attributes: inline, virtual

Source: Source/Schola/Public/Common/Points/DictPoint.h

FDictPoint

inline FDictPoint(
std::initializer_list<TPair<FString, TInstancedStruct<FPoint>>> InPoints)

Constructs a dictionary from an initializer list of key-value pairs.

Parameters

InPoints – [in] An initializer list of string-point pairs.

Attributes: inline

Source: Source/Schola/Public/Common/Points/DictPoint.h

Accept

inline virtual void Accept(PointVisitor &Visitor) override

Accepts a mutable visitor for the visitor pattern.

Parameters

Visitor – [inout] The visitor to accept.

#DirectionNameTypeDescription
1VisitorPointVisitor &The visitor to accept.

Attributes: inline, virtual

Source: Source/Schola/Public/Common/Points/DictPoint.h

Accept

inline virtual void Accept(ConstPointVisitor &Visitor) const override

Accepts a const visitor for the visitor pattern.

Parameters

Visitor – [inout] The const visitor to accept.

#DirectionNameTypeDescription
1VisitorPointVisitor &The visitor to accept.

Attributes: inline, virtual

Source: Source/Schola/Public/Common/Points/DictPoint.h

Reset

inline virtual void Reset() override

Resets the dictionary, removing all points.

Attributes: inline, virtual

Source: Source/Schola/Public/Common/Points/DictPoint.h

ToString

inline virtual FString ToString() const override

Converts this dictionary point to a string representation.

Returns:

A string showing all key-value pairs in the dictionary.

Attributes: inline, const, virtual

Source: Source/Schola/Public/Common/Points/DictPoint.h


Public Members

SymbolDetails
PointsThe map of named points in this dictionary.

Points

TMap<FString, TInstancedStruct<FPoint>> Points

The map of named points in this dictionary.

Each entry is a string key paired with a point value.