HOutputHandlerOptions
-
class
HOutputHandlerOptions HOutputHandlerOptionsis used to pass data toHOutputHandler. All options are used based on the handler’s needs. SpecificHOutputHandlersubclassed instances should document their own usage of options.Index
Methods
ActivateOnPageOpen()ActivateOnPageOpen()AnnotBottom()AnnotBottom()AnnotLeft()AnnotLeft()AnnotRight()AnnotRight()AnnotTop()AnnotTop()Ascii()Ascii()Camera()Camera()ConserveMemory()ConserveMemory()ExtendedData()ExtendedData()ExtendedData()FastPrint()FastPrint()ForceGrayscale()ForceGrayscale()GetType()HOutputHandlerOptions()HOutputHandlerOptions()HOutputHandlerOptions()HSRAOptions()HSRAOptions()ImageDpi()ImageDpi()Init()Key()Key()Layout()Layout()LineFuseThreshold()LineFuseThreshold()Model()Model()Output3d()Output3d()OutputType()OutputType()PaperDpi()PaperDpi()PaperHeight()PaperHeight()PaperWidth()PaperWidth()PopulateOptions()PrintToScale()PrintToScale()StlNormals()StlNormals()UseSubscreen()UseSubscreen()UseWindowColor()UseWindowColor()Version()Version()View()View()WindowColor()WindowColor()WindowFrame()WindowFrame()WindowHeight()WindowHeight()WindowWidth()WindowWidth()WriteAnimations()WriteAnimations()~HOutputHandlerOptions()
Variables
m_antialiasLevelm_b3dOutputm_bActivateOnPageOpenm_bAsciim_bAVICodecm_bAVIShowCompressionDialogm_bConserveMemorym_bExporting2DDwfm_bFastPrintm_bHTMLIncludeMeasurementInformationm_bPDFEmbedFontsm_bPrcCompressTessellationm_bPrcRemoveAttributesm_bPrcRemoveBRepm_bPrcUseNameUserDatam_bStlNormalsm_bUseWindowColorm_bWindowFramem_bWriteAnimationsm_ePrcBrepCompressionm_fAnnotBottomm_fAnnotLeftm_fAnnotRightm_fAnnotTopm_ForceGrayscalem_Image_Dpim_imageOutputBufferm_imageOutputBufferSizem_iPrcNameUserDataIndexm_jpeg_qualitym_Keym_layoutm_licensem_lineFuseThresholdm_namesm_OutputTypem_PageMarginsm_Paper_Dpim_Paper_Heightm_Paper_Widthm_pBehaviorManagerm_pCameram_pDWFModelNamem_pExtendedDatam_pHBaseModelm_pHBaseViewm_pHSRAOptionsm_pHTMLTemplateFilem_pPDFResourceDirectorym_pPRCAsmModelFilem_pWindowColorm_ratio_cm_to_internal_unitsm_Versionm_Window_Heightm_Window_Width
Enumerations
Methods
-
HOutputHandlerOptions::HOutputHandlerOptions() = default Constructs an
HOutputHandlerOptionsobject.
-
virtual char const *
HOutputHandlerOptions::GetType() const const virtual
-
virtual bool
HOutputHandlerOptions::PopulateOptions() virtual
Any application wishing to customize how the options are populated should derive from this class and overload this function.
-
HOutputHandlerOptions::HOutputHandlerOptions(HOutputHandlerOptions const *o) Constructs an
HOutputHandlerOptionsobject from anotherHOutputHandlerOptionsobject.Parameters
o: A pointer to theHOutputHandlerOptionsobject you want to copy.
-
HOutputHandlerOptions::HOutputHandlerOptions(HOutputHandlerOptions const &o) Constructs an
HOutputHandlerOptionsobject from anotherHOutputHandlerOptionsobject.Parameters
o: A reference to theHOutputHandlerOptionsobject you want to copy.
-
virtual
HOutputHandlerOptions::~HOutputHandlerOptions() virtual
-
void
HOutputHandlerOptions::Init(HOutputHandlerOptions const *o) This method initializes this
HOutputHandlerOptionsobject from using the properties of anotherHOutputHandlerOptionsobject.Parameters
o: A pointer to theHOutputHandlerOptionsobject you want to copy.
-
HBaseView *
HOutputHandlerOptions::View() const const
A pointer to the HBaseView object for this output.
-
void
HOutputHandlerOptions::View(HBaseView *const v) A pointer to the HBaseView object for this output.
-
HBaseModel *
HOutputHandlerOptions::Model() const const
A pointer to the HBaseModel object for this output.
-
void
HOutputHandlerOptions::Model(HBaseModel *const m) A pointer to the HBaseModel object for this output.
-
HCamera *
HOutputHandlerOptions::Camera() const const
A pointer to the HCamera object for this output.
-
void
HOutputHandlerOptions::Camera(HCamera *const c) A pointer to the HCamera object for this output.
-
HC_KEY
HOutputHandlerOptions::Key() const const
The HC_Key for this output.
-
void
HOutputHandlerOptions::Key(HC_KEY const k) The HC_Key for this output.
-
char const *
HOutputHandlerOptions::HSRAOptions() const const
HOOPS HSRAOption string .
-
void
HOutputHandlerOptions::HSRAOptions(char const *const tf) HOOPS HSRAOption string .
-
HPoint const *
HOutputHandlerOptions::WindowColor() const const
Set the color of the window. The RGB color stored in xyz of HPoint.
-
void
HOutputHandlerOptions::WindowColor(HPoint const *const tf) Set the color of the window. The RGB color stored in xyz of HPoint.
-
bool
HOutputHandlerOptions::UseWindowColor() const const
If set to true, the background color of the view is used.
-
void
HOutputHandlerOptions::UseWindowColor(bool const tf) If set to true, the background color of the view is used.
-
float
HOutputHandlerOptions::WindowWidth() const const
Width for output sizing in inches.
-
void
HOutputHandlerOptions::WindowWidth(float const f) Width for output sizing in inches.
-
float
HOutputHandlerOptions::WindowHeight() const const
Height for output sizing in inches.
-
void
HOutputHandlerOptions::WindowHeight(float const f) Height for output sizing in inches.
-
float
HOutputHandlerOptions::PaperWidth() const const
Width for output sizing in inches.
-
void
HOutputHandlerOptions::PaperWidth(float const f) Width for output sizing in inches.
-
float
HOutputHandlerOptions::PaperHeight() const const
Height for output sizing in inches.
-
void
HOutputHandlerOptions::PaperHeight(float const f) Height for output sizing in inches.
-
bool
HOutputHandlerOptions::ForceGrayscale() const const
Specifies black and white output.
-
void
HOutputHandlerOptions::ForceGrayscale(bool const tf) Specifies black and white output.
-
size_t
HOutputHandlerOptions::LineFuseThreshold() const const
Gets the line fuse threshold
Returns
The line fuse threshold value
-
void
HOutputHandlerOptions::LineFuseThreshold(size_t const tf) Sets the line fuse threshold value.
Parameters
tf: The line fuse threshold value to set
-
bool
HOutputHandlerOptions::FastPrint() const const
This option has been deprecated. Specifies printing method.
-
void
HOutputHandlerOptions::FastPrint(bool const tf) This option has been deprecated. Specifies printing method.
-
bool
HOutputHandlerOptions::ConserveMemory() const const
This option has been deprecated and has no effect.
-
void
HOutputHandlerOptions::ConserveMemory(bool const tf) This option has been deprecated and has no effect.
-
bool
HOutputHandlerOptions::WriteAnimations() const const
-
void
HOutputHandlerOptions::WriteAnimations(bool const tf)
-
bool
HOutputHandlerOptions::WindowFrame() const const
Determines if a window frame is drawn or not.
-
void
HOutputHandlerOptions::WindowFrame(bool const tf) Determines if a window frame is drawn or not.
-
Print_Layout
HOutputHandlerOptions::Layout() const const
Determines how the view or camera will be mapped to the printed page.
-
void
HOutputHandlerOptions::Layout(Print_Layout l) Determines how the view or camera will be mapped to the printed page.
-
bool
HOutputHandlerOptions::UseSubscreen() const deprecated const
Determines if HOOPS is calculating a subscreen to match the output to the size of the view window.
Warning
This function will be replaced by
Layout()
-
void
HOutputHandlerOptions::UseSubscreen(bool tf) deprecated
Determines if HOOPS is calculating a subscreen to match the output to the size of the view window.
Warning
This function will be replaced by
Layout(Print_Layout l)
-
int
HOutputHandlerOptions::ImageDpi() const const
Indicates the DPI used for images. This is calculated with info from HC_Show_Device_Info.
-
void
HOutputHandlerOptions::ImageDpi(int const dpi) Indicates the DPI used for images. This is calculated with info from HC_Show_Device_Info.
-
int
HOutputHandlerOptions::PaperDpi() const const
Indicates the DPI used for paper. This is set from the options dialog.
-
void
HOutputHandlerOptions::PaperDpi(int const dpi) Indicates the DPI used for paper. This is set from the options dialog.
-
void *
HOutputHandlerOptions::ExtendedData() const const
-
void
HOutputHandlerOptions::ExtendedData(void *const vp)
-
void
HOutputHandlerOptions::ExtendedData(HPDFOptions *const vp)
-
bool
HOutputHandlerOptions::ActivateOnPageOpen() const const
-
void
HOutputHandlerOptions::ActivateOnPageOpen(bool onoff)
-
float
HOutputHandlerOptions::AnnotLeft() const const
-
void
HOutputHandlerOptions::AnnotLeft(float f)
-
float
HOutputHandlerOptions::AnnotRight() const const
-
void
HOutputHandlerOptions::AnnotRight(float f)
-
float
HOutputHandlerOptions::AnnotBottom() const const
-
void
HOutputHandlerOptions::AnnotBottom(float f)
-
float
HOutputHandlerOptions::AnnotTop() const const
-
void
HOutputHandlerOptions::AnnotTop(float f)
-
int
HOutputHandlerOptions::Version() const const
-
void
HOutputHandlerOptions::Version(int const v)
-
H_OUTPUT_TYPE
HOutputHandlerOptions::OutputType() const const
The output type.
-
void
HOutputHandlerOptions::OutputType(H_OUTPUT_TYPE ot) The output type.
-
bool
HOutputHandlerOptions::Output3d() const const
Some file formats, such as PDF and DWF, support 2d and/or 3d output. Set this to TRUE for 3d output.
-
void
HOutputHandlerOptions::Output3d(bool const tf) Some file formats, such as PDF and DWF, support 2d and/or 3d output. Set this to TRUE for 3d output. Default is FALSE.
-
bool
HOutputHandlerOptions::Ascii() const const
Some file formats, support binary and ascii such as STL. Set this to true for ascii output.
-
void
HOutputHandlerOptions::Ascii(bool const tf) Some file formats, support binary and ascii such as STL. Set this to true for ascii output.
-
bool
HOutputHandlerOptions::StlNormals() const const
Determines if we generate and output face normals when writing to STL file format.
-
void
HOutputHandlerOptions::StlNormals(bool const tf) Determines if we generate and output face normals when writing to STL file format.
-
double
HOutputHandlerOptions::PrintToScale() const const
Returns
The output scaling ratio. SeePrintToScale()
-
void
HOutputHandlerOptions::PrintToScale(double const r) Parameter is a positive double precision ratio which specifies how many HOOPS/3DGS world-space-units represents a centimeter. The camera will (temporarily) be scaled according to this ratio to force the physical (hardcopy) output size to match an application’s size units. A natural side-effect of this style of output is that the hardcopy will not match the picture on the screen like normal HOOPS printing. The output will effectively be scaled (up or down) and given a new aspect ratio so that it will fill the printable area of the specified output device with to-scale geometry surrounding the camera target.
Examples:
- If a value of 1.0 in HOOPS/3DGS world-space is meant to represent 2 mm, set the ratio to 0.2
- If a value of 1.0 in HOOPS/3DGS world-space is meant to represent 1 inch, set the ratio to 2.54
- If a value of 1.0 in HOOPS/3DGS world-space is meant to represent 1 cm, set the ratio to 1.0
Behavioral Notes:
- This mode will respect user-defined margins.
- PrintToScale behavior is undefined if there is a perspective camera.
The default value is 0, which indicates to not print-to-scale.
Variables
-
HBaseView *
HOutputHandlerOptions::m_pHBaseView - HBaseView
A pointer to the HBaseView object for this output.
-
HBaseModel *
HOutputHandlerOptions::m_pHBaseModel - HBaseModel
A pointer to the HBaseModel object for this output.
-
HCamera *
HOutputHandlerOptions::m_pCamera - HCamera
A pointer to the HCamera object for this output.
-
HC_KEY
HOutputHandlerOptions::m_Key - HC_KEY
The HC_Key for this output.
-
char const *
HOutputHandlerOptions::m_pHSRAOptions - char const
HOOPS HSRAOption string .
-
HPoint const *
HOutputHandlerOptions::m_pWindowColor - HPoint const
RGB color stored in xyz.
-
bool
HOutputHandlerOptions::m_bUseWindowColor - bool
If set to true, the background color of the view is used.
-
float
HOutputHandlerOptions::m_Window_Width - float
Width for output sizing in inches.
-
float
HOutputHandlerOptions::m_Window_Height - float
Height for output sizing in inches.
-
float
HOutputHandlerOptions::m_Paper_Width - float
Width for output sizing in inches.
-
float
HOutputHandlerOptions::m_Paper_Height - float
Height for output sizing in inches.
-
bool
HOutputHandlerOptions::m_ForceGrayscale - bool
Specifies black and white output.
-
size_t
HOutputHandlerOptions::m_lineFuseThreshold - size_t
If the number of lines in a segment is greater than or equal to this value, the lines are fused into a single line during export. This option applies to 3D PDF exports only. The default value is 100.
-
bool
HOutputHandlerOptions::m_bFastPrint - bool
This option has been deprecated. Specifies printing method.
-
bool
HOutputHandlerOptions::m_bConserveMemory - bool
This option has been deprecated and has no effect.
-
bool
HOutputHandlerOptions::m_bWriteAnimations - bool
-
bool
HOutputHandlerOptions::m_bWindowFrame - bool
Determines if a window frame is drawn or not.
-
Print_Layout
HOutputHandlerOptions::m_layout -
Determines how the view or camera will be mapped to the printed page.
-
int
HOutputHandlerOptions::m_Image_Dpi - int
Indicates the DPI used for images. This is calculated with info from HC_Show_Device_Info.
-
int
HOutputHandlerOptions::m_Paper_Dpi - int
Indicates the DPI used for paper. This is set from the options dialog.
-
void *
HOutputHandlerOptions::m_pExtendedData - void
A pointer to extra data needed by a
HOutputHandlersubclass .
-
char const *
HOutputHandlerOptions::m_license - char const
A pointer to a license key. This can be used by HIO modules that are based on 3rd party toolkits which require a license key to be set.
-
int
HOutputHandlerOptions::m_antialiasLevel - int
-
int
HOutputHandlerOptions::m_jpeg_quality - int
-
unsigned char *
HOutputHandlerOptions::m_imageOutputBuffer - unsigned char
-
size_t
HOutputHandlerOptions::m_imageOutputBufferSize - size_t
-
int
HOutputHandlerOptions::m_Version - int
The file format version desired for writing.
-
H_OUTPUT_TYPE
HOutputHandlerOptions::m_OutputType - H_OUTPUT_TYPE
The output type.
-
bool
HOutputHandlerOptions::m_b3dOutput - bool
Some file formats, such as PDF and DWF, support 2d and/or 3d output. Set this to TRUE for 3d output. Default is FALSE.
-
bool
HOutputHandlerOptions::m_bAscii - bool
Some file formats, support binary and ascii such as STL. Set this to true for ascii output.
-
bool
HOutputHandlerOptions::m_bStlNormals - bool
Determines if we generate and output face normals when writing to STL file format.
-
double
HOutputHandlerOptions::m_ratio_cm_to_internal_units - double
The output scaling ratio. See
PrintToScale()
-
float
HOutputHandlerOptions::m_PageMargins[4] - float
Sets the page margin in inches. m_PageMargins[0] is the left margin m_PageMargins[1] is the right margin m_PageMargins[2] is the bottom margin m_PageMargins[3] is the top margin
-
HBhvBehaviorManager *
HOutputHandlerOptions::m_pBehaviorManager - HBhvBehaviorManager
A pointer to the behavior manager.
-
char const *
HOutputHandlerOptions::m_pDWFModelName - char const
DWF Model name
-
char const *
HOutputHandlerOptions::m_pPDFResourceDirectory - char const
Publish resource directory. Setting this directory is required for 3D PDF export. Normally, this directory is HOOPS_PUBLISH_INSTALL_DIR/bin/resource.
-
ExportNameMap
HOutputHandlerOptions::m_names -
available for output handlers to map HC_KEYS to names in the output file.
-
void *
HOutputHandlerOptions::m_pPRCAsmModelFile - void
Pointer to a PRC model
-
bool
HOutputHandlerOptions::m_bActivateOnPageOpen - bool
Set this member to true if you want the 3D annotation in a 3D PDF document to be automatically enabled when opening the PDF file. Default is false
-
float
HOutputHandlerOptions::m_fAnnotLeft - float
This setting applies to the positioning of a 3D annotation in a 3D PDF, and defines the distance, in inches, from the page’s left border, where the left side of the annotation should be located. The default is 0.5
-
float
HOutputHandlerOptions::m_fAnnotRight - float
This setting applies to the positioning of a 3D annotation in a 3D PDF, and defines the distance, in inches, from the page’s right border, where the right of the annotation should be located. The default is 0.5
-
float
HOutputHandlerOptions::m_fAnnotBottom - float
This setting applies to the positioning of a 3D annotation in a 3D PDF, and defines the distance, in inches, from the page’s bottom border, where the bottom of the annotation should be located. The default is 2.0
-
float
HOutputHandlerOptions::m_fAnnotTop - float
This setting applies to the positioning of a 3D annotation in a 3D PDF, and defines the distance, in inches, from the page’s top border, where the top of the of the annotation should be located. The default is 0.5
-
HPrcBrepCompression
HOutputHandlerOptions::m_ePrcBrepCompression -
Sets the compression level for BRep data when exporting to the PRC format. Defaults to PrcBrepCompressionNone.
-
bool
HOutputHandlerOptions::m_bPrcRemoveBRep - bool
Sets whether to remove BREP data when exporting to the PRC format. Defaults to false.
-
bool
HOutputHandlerOptions::m_bPrcRemoveAttributes - bool
Sets whether to remove attribute data when exporting to the PRC format. Defaults to false.
-
bool
HOutputHandlerOptions::m_bPrcUseNameUserData - bool
Sets whether to use the m_iPrcNameUserDataIndex field. Defaults to false.
-
MVO_POINTER_SIZED_INT
HOutputHandlerOptions::m_iPrcNameUserDataIndex - MVO_POINTER_SIZED_INT
Sets the user data index for the UTF8-encoded name to use for PRC entities when creating PRC data from a scene graph.
-
bool
HOutputHandlerOptions::m_bPrcCompressTessellation - bool
Sets whether to compress tessellation data when exporting to the PRC format. Defaults to false.
-
bool
HOutputHandlerOptions::m_bAVIShowCompressionDialog - bool
Used in HIO_AVI. If true shows a dialog during export to allow the user to select a compression level. Defaults to true.
-
char
HOutputHandlerOptions::m_bAVICodec[4] - char
Used in HIO_AVI. Sets the AVI codec for function mmioFOURCC Default codec is UNCOMPRESSED m_bAVICodec[0] First character of the four-character code. m_bAVICodec[1] Second character of the four-character code. m_bAVICodec[2] Third character of the four-character code. m_bAVICodec[3] Fourth character of the four-character code.
-
bool
HOutputHandlerOptions::m_bExporting2DDwf - bool
2D Dwf Export uses a legacy version of Hardcopy. Set this option to true when exporting a 2D DWF file
-
char const *
HOutputHandlerOptions::m_pHTMLTemplateFile - char const
Path to the template file to use when generating an HTML file from HIOUtilityPublish. This value is REQUIRED for HTML export to succeed.
-
bool
HOutputHandlerOptions::m_bHTMLIncludeMeasurementInformation - bool
Whether to include measurement information when generating an HTML file from HIOUtilityPublish.
-
bool
HOutputHandlerOptions::m_bPDFEmbedFonts - bool
Whether to embed fonts in exported 2D PDF files. Embedding fonts makes the PDF exported file bigger, but enables text contained within it to render correctly even on platforms that lack the font used when creating the file.