UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.LabelMaker.PrintPlane Class Reference

A print plane is a 2-dimensional plane with a ruler for object placement and printer resolution needed to correlate ruler units to native printer dots. More...

Inheritance diagram for com.UniPRT.Sdk.LabelMaker.PrintPlane:
com.UniPRT.Sdk.LabelMaker.Interface.IPrintPlane

Public Member Functions

 PrintPlane ()
 
 PrintPlane (IRuler ruler)
 
 PrintPlane (IRuler ruler, IPrintResolution printResolution)
 
IPrintResolution GetPrinterResolution ()
 The printer resolution used for all objects on plane. More...
 
void SetPrinterResolution (IPrintResolution printerResolution)
 
IRuler GetRuler ()
 The ruler used by all objects if a specific ruler is not changed or provided. More...
 
void SetRuler (IRuler ruler)
 
float DotsPerUnit (IRuler ruler, IPrintResolution resolution)
 
float DotsPerUnit (IRuler ruler)
 
float DotsToPoints (float dots, IPrintResolution resolution)
 
float DotsToPoints (float dots)
 
float InchToDots (float inchValue, IPrintResolution resolution)
 
float InchToDots (float inchValue)
 
float InchToPoints (float inchValue, IPrintResolution resolution)
 
float InchToPoints (float inchValue)
 
float MMToDots (float mmValue, IPrintResolution resolution)
 
float MMToDots (float mmValue)
 
float MMToPoints (float mmValue, IPrintResolution resolution)
 
float MMToPoints (float mmValue)
 
float ToPoints (float scaledNumber, IRuler ruler, IPrintResolution resolution)
 
float ToPoints (float scaledNumber, IRuler ruler)
 
float ToPoints (float scaledNumber)
 
float ToDots (float scaledNumber, IRuler ruler, IPrintResolution resolution)
 
float ToDots (float scaledNumber, IRuler ruler)
 
float ToDots (float scaledNumber)
 
float ToInch (float scaledNumber, IRuler ruler, IPrintResolution resolution)
 
float ToInch (float scaledNumber, IRuler ruler)
 
float ToInch (float scaledNumber)
 
float ToMM (float scaledNumber, IRuler ruler, IPrintResolution resolution)
 
float ToMM (float scaledNumber, IRuler ruler)
 
float ToMM (float scaledNumber)
 
IPoint ToDots (IPoint scaledPosition, IRuler ruler, IPrintResolution resolution)
 
IPoint ToDots (IPoint scaledPosition, IRuler ruler)
 
IPoint ToDots (IPoint scaledPosition)
 

Static Public Member Functions

static int Round (float numToRound)
 Round a float to integer. More...
 

Private Attributes

IPrintResolution printerResolution
 
IRuler ruler
 

Detailed Description

A print plane is a 2-dimensional plane with a ruler for object placement and printer resolution needed to correlate ruler units to native printer dots.

Constructor & Destructor Documentation

◆ PrintPlane() [1/3]

com.UniPRT.Sdk.LabelMaker.PrintPlane.PrintPlane ( )

◆ PrintPlane() [2/3]

com.UniPRT.Sdk.LabelMaker.PrintPlane.PrintPlane ( IRuler  ruler)

◆ PrintPlane() [3/3]

Member Function Documentation

◆ DotsPerUnit() [1/2]

◆ DotsPerUnit() [2/2]

◆ DotsToPoints() [1/2]

float com.UniPRT.Sdk.LabelMaker.PrintPlane.DotsToPoints ( float  dots)

◆ DotsToPoints() [2/2]

◆ GetPrinterResolution()

◆ GetRuler()

IRuler com.UniPRT.Sdk.LabelMaker.PrintPlane.GetRuler ( )

The ruler used by all objects if a specific ruler is not changed or provided.

By changing the settings of this ruler, it allows all objects to use a common ruler scale/resolution.

Implements com.UniPRT.Sdk.LabelMaker.Interface.IPrintPlane.

References com.UniPRT.Sdk.LabelMaker.PrintPlane.ruler.

Referenced by com.UniPRT.Sdk.LabelMaker.PrintPlane.DotsPerUnit(), com.UniPRT.Sdk.LabelMaker.PrintPlane.ToDots(), com.UniPRT.Sdk.LabelMaker.PrintPlane.ToInch(), com.UniPRT.Sdk.LabelMaker.PrintPlane.ToMM(), and com.UniPRT.Sdk.LabelMaker.PrintPlane.ToPoints().

◆ InchToDots() [1/2]

float com.UniPRT.Sdk.LabelMaker.PrintPlane.InchToDots ( float  inchValue)

◆ InchToDots() [2/2]

◆ InchToPoints() [1/2]

float com.UniPRT.Sdk.LabelMaker.PrintPlane.InchToPoints ( float  inchValue)

◆ InchToPoints() [2/2]

float com.UniPRT.Sdk.LabelMaker.PrintPlane.InchToPoints ( float  inchValue,
IPrintResolution  resolution 
)

◆ MMToDots() [1/2]

float com.UniPRT.Sdk.LabelMaker.PrintPlane.MMToDots ( float  mmValue)

◆ MMToDots() [2/2]

◆ MMToPoints() [1/2]

float com.UniPRT.Sdk.LabelMaker.PrintPlane.MMToPoints ( float  mmValue)

◆ MMToPoints() [2/2]

float com.UniPRT.Sdk.LabelMaker.PrintPlane.MMToPoints ( float  mmValue,
IPrintResolution  resolution 
)

◆ Round()

◆ SetPrinterResolution()

void com.UniPRT.Sdk.LabelMaker.PrintPlane.SetPrinterResolution ( IPrintResolution  printerResolution)

◆ SetRuler()

void com.UniPRT.Sdk.LabelMaker.PrintPlane.SetRuler ( IRuler  ruler)

◆ ToDots() [1/6]

◆ ToDots() [2/6]

◆ ToDots() [3/6]

◆ ToDots() [4/6]

◆ ToDots() [5/6]

◆ ToDots() [6/6]

◆ ToInch() [1/3]

◆ ToInch() [2/3]

◆ ToInch() [3/3]

◆ ToMM() [1/3]

◆ ToMM() [2/3]

◆ ToMM() [3/3]

◆ ToPoints() [1/3]

◆ ToPoints() [2/3]

◆ ToPoints() [3/3]

Member Data Documentation

◆ printerResolution

◆ ruler


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