Inheritance diagram for HPS.Hardcopy:

Classes

class  File
 
class  GDI
 

Public Types

enum  BackgroundPreference : uint { BackgroundPreference.UseBackgroundColor = 0x00000000, BackgroundPreference.ForceSolidWhite = 0x00000001 }
 
enum  PDFFontPreference : uint { PDFFontPreference.DoNotEmbedFonts = 0x00000000, PDFFontPreference.EmbedFonts = 0x00000001 }
 
enum  RenderingAlgorithm : uint { RenderingAlgorithm.TwoPassPrint = 0x00000000, RenderingAlgorithm.SinglePassPrint = 0x00000001 }
 
enum  ResolutionUnits : uint { ResolutionUnits.DPCM = 0x00000000, ResolutionUnits.DPI = 0x00000001, ResolutionUnits.DotsPerCentimeter = 0x00000000, ResolutionUnits.DotsPerInch = 0x00000001 }
 
enum  SizeUnits : uint { SizeUnits.Centimeters = 0x00000000, SizeUnits.Inches = 0x00000001 }
 

Public Member Functions

virtual void Dispose ()
 
 Hardcopy (HPS.Hardcopy in_that)
 

Protected Member Functions

virtual void deleteCptr ()
 

Protected Attributes

bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The Hardcopy class attempts to reproduce the scene graph to each of its supported export types. This includes printing to physical paper and 2D PDF.

Default values for the various fields of the Hardcopy class can be found here.

Member Enumeration Documentation

◆ BackgroundPreference

The Hardcopy.BackgroundPreference class is used to decide what the Hardcopy background looks like.

Enumerator
UseBackgroundColor 

The current scene background is exported to Hardcopy.

ForceSolidWhite 

The exported Hardcopy background will be white.

◆ PDFFontPreference

enum HPS.Hardcopy.PDFFontPreference : uint
strong

The Hardcopy.PDFFontPreference class is used to decide how fonts are treated during PDF exports

Enumerator
DoNotEmbedFonts 

Fonts used are not embedded in exported PDF files. The resulting file will only look correct when opened on platforms which have the fonts used in the PDF document installed.

EmbedFonts 

Fonts used in the PDF are embedded into it. The exported PDF file will render the same way on any platform. Its size will be larger than if fonts were not embedded.

◆ RenderingAlgorithm

enum HPS.Hardcopy.RenderingAlgorithm : uint
strong

The Hardcopy.RenderingOptions class is used to decide how the Hardcopy export will be conducted.

Enumerator
TwoPassPrint 

The default Hardcopy export. Two passes are used to ensure that vector data is as detailed as possible, while saving on file size by rendering non-vector data at lower resolution.

SinglePassPrint 

The Hardcopy export completes in a single pass. Non-vector data may take up large amount of space on disk. If your on-screen scene was rendered using the Priority HSRA, using SinglePassPrint is required in order for the Hardcopy export to be accurate.

◆ ResolutionUnits

enum HPS.Hardcopy.ResolutionUnits : uint
strong

The Hardcopy.Resolution class is a concept class for hardcopy output-resolution-related enum classes.

Enumerator
DPCM 

Dots Per Centimeter.

DPI 

Dots Per Inch.

DotsPerCentimeter 

Dots Per Centimeter.

DotsPerInch 

Dots Per Inch.

◆ SizeUnits

enum HPS.Hardcopy.SizeUnits : uint
strong

The Hardcopy.Size class is a concept class for hardcopy output-size-related enum classes.

Enumerator
Centimeters 

Centimeters.

Inches 

Inches.


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.Hardcopy.cs