Back to FabImage Library website

You are here: Start » Function Reference » Basic » Format » FormatPoint2DToString

FormatPoint2DToString


Header: FIL.h
Namespace: fil
Module: FoundationLite

Converts a 2D point to a string of format "(X, Y)".

Syntax

C++
C#
 
void fil::FormatPoint2DToString
(
	const fil::Point2D& inPoint,
	const int inIntegerDigitCount,
	const int inFractionalDigitCount,
	const ftl::String& inDecimalMark,
	const ftl::String& inTrailingCharacter,
	const bool inForceSignPrinting,
	const ftl::String& inSuffix,
	const bool inPrintBrackets,
	ftl::String& outString
)

Parameters

Name Type Range Default Description
Input value inPoint const Point2D&
Input value inIntegerDigitCount const int 0 - How many characters the integer part of the coordinates should have at least
Input value inFractionalDigitCount const int 0 - 100 3 How many characters the fractional part of the coordinates should have
Input value inDecimalMark const String& \".\" The symbol used to separate the integer part from the fractional part of the coordinates
Input value inTrailingCharacter const String& \"0\" Defines the trailing character
Input value inForceSignPrinting const bool False Forces printing the signs of the numbers even if the number is positive
Input value inSuffix const String& \"\" Defines a suffix. Generally it is an unit of value (e.g. mm)
Input value inPrintBrackets const bool True Determines whether the brackets should be printed or not
Output value outString String&