HOutputHandlerOptions Class Reference

#include <HIOManager.h>

Public Member Functions

bool ActivateOnPageOpen () const
 
void ActivateOnPageOpen (bool onoff)
 
float AnnotBottom () const
 
void AnnotBottom (float f)
 
float AnnotLeft () const
 
void AnnotLeft (float f)
 
float AnnotRight () const
 
void AnnotRight (float f)
 
float AnnotTop () const
 
void AnnotTop (float f)
 
bool Ascii () const
 Some file formats, support binary and ascii such as STL. Set this to true for ascii output.
 
void Ascii (bool const tf)
 Some file formats, support binary and ascii such as STL. Set this to true for ascii output.
 
HCameraCamera () const
 A pointer to the HCamera object for this output.
 
void Camera (HCamera *const c)
 A pointer to the HCamera object for this output.
 
bool ConserveMemory () const
 This option has been deprecated and has no effect.
 
void ConserveMemory (bool const tf)
 This option has been deprecated and has no effect.
 
void * ExtendedData () const
 
void ExtendedData (void *const vp)
 
void ExtendedData (HPDFOptions *const vp)
 
bool FastPrint () const
 This option has been deprecated. Specifies printing method.
 
void FastPrint (bool const tf)
 This option has been deprecated. Specifies printing method.
 
bool ForceGrayscale () const
 Specifies black and white output.
 
void ForceGrayscale (bool const tf)
 Specifies black and white output.
 
virtual char const * GetType () const
 
 HOutputHandlerOptions ()
 
 HOutputHandlerOptions (HOutputHandlerOptions const *o)
 
 HOutputHandlerOptions (const HOutputHandlerOptions &o)
 
char const * HSRAOptions () const
 HOOPS HSRAOption string .
 
void HSRAOptions (char const *const tf)
 HOOPS HSRAOption string .
 
int ImageDpi () const
 Indicates the DPI used for images. This is calculated with info from HC_Show_Device_Info.
 
void ImageDpi (int const dpi)
 Indicates the DPI used for images. This is calculated with info from HC_Show_Device_Info.
 
void Init (HOutputHandlerOptions const *o)
 
HC_KEY Key () const
 The HC_Key for this output.
 
void Key (HC_KEY const k)
 The HC_Key for this output.
 
size_t LineFuseThreshold () const
 
void LineFuseThreshold (size_t const tf)
 
HBaseModelModel () const
 A pointer to the HBaseModel object for this output.
 
void Model (HBaseModel *const m)
 A pointer to the HBaseModel object for this output.
 
bool Output3d () const
 Some file formats, such as PDF and DWF, support 2d and/or 3d output. Set this to TRUE for 3d output.
 
void 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.
 
H_OUTPUT_TYPE OutputType () const
 The output type.
 
void OutputType (H_OUTPUT_TYPE ot)
 The output type.
 
int PaperDpi () const
 Indicates the DPI used for paper. This is set from the options dialog.
 
void PaperDpi (int const dpi)
 Indicates the DPI used for paper. This is set from the options dialog.
 
float PaperHeight () const
 Height for output sizing in inches.
 
void PaperHeight (float const f)
 Height for output sizing in inches.
 
float PaperWidth () const
 Width for output sizing in inches.
 
void PaperWidth (float const f)
 Width for output sizing in inches.
 
virtual bool PopulateOptions ()
 
double PrintToScale () const
 
void PrintToScale (double const r)
 
bool StlNormals () const
 Determines if we generate and output face normals when writing to STL file format.
 
void StlNormals (bool const tf)
 Determines if we generate and output face normals when writing to STL file format.
 
bool UseSubscreen () const
 Determines if HOOPS is calculating a subscreen to match the output to the size of the view window.
 
void UseSubscreen (bool const tf)
 Determines if HOOPS is calculating a subscreen to match the output to the size of the view window.
 
bool UseWindowColor () const
 If set to true, the background color of the view is used.
 
void UseWindowColor (bool const tf)
 If set to true, the background color of the view is used.
 
int Version () const
 
void Version (int const v)
 
HBaseViewView () const
 A pointer to the HBaseView object for this output.
 
void View (HBaseView *const v)
 A pointer to the HBaseView object for this output.
 
HPoint const * WindowColor () const
 Set the color of the window. The RGB color stored in xyz of HPoint.
 
void WindowColor (HPoint const *const tf)
 Set the color of the window. The RGB color stored in xyz of HPoint.
 
bool WindowFrame () const
 Determines if a window frame is drawn or not.
 
void WindowFrame (bool const tf)
 Determines if a window frame is drawn or not.
 
float WindowHeight () const
 Height for output sizing in inches.
 
void WindowHeight (float const f)
 Height for output sizing in inches.
 
float WindowWidth () const
 Width for output sizing in inches.
 
void WindowWidth (float const f)
 Width for output sizing in inches.
 
bool WriteAnimations () const
 
void WriteAnimations (bool const tf)
 

Public Attributes

int m_antialiasLevel
 
bool m_b3dOutput
 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 m_bActivateOnPageOpen
 
bool m_bAscii
 Some file formats, support binary and ascii such as STL. Set this to true for ascii output.
 
char m_bAVICodec [4]
 
bool m_bAVIShowCompressionDialog
 
bool m_bConserveMemory
 This option has been deprecated and has no effect.
 
bool m_bExporting2DDwf
 
bool m_bFastPrint
 This option has been deprecated. Specifies printing method.
 
bool m_bHTMLIncludeMeasurementInformation
 
bool m_bPrcCompressTessellation
 
bool m_bPrcRemoveAttributes
 
bool m_bPrcRemoveBRep
 
bool m_bPrcUseNameUserData
 
bool m_bStlNormals
 Determines if we generate and output face normals when writing to STL file format.
 
bool m_bUseSubscreen
 Determines if HOOPS is calculating a subscreen to match the output to the size of the view window.
 
bool m_bUseWindowColor
 If set to true, the background color of the view is used.
 
bool m_bWindowFrame
 Determines if a window frame is drawn or not.
 
bool m_bWriteAnimations
 
HPrcBrepCompression m_ePrcBrepCompression
 
float m_fAnnotBottom
 
float m_fAnnotLeft
 
float m_fAnnotRight
 
float m_fAnnotTop
 
bool m_ForceGrayscale
 Specifies black and white output.
 
int m_Image_Dpi
 Indicates the DPI used for images. This is calculated with info from HC_Show_Device_Info.
 
unsigned char * m_imageOutputBuffer
 
size_t m_imageOutputBufferSize
 
MVO_POINTER_SIZED_INT m_iPrcNameUserDataIndex
 
int m_jpeg_quality
 
HC_KEY m_Key
 The HC_Key for this output.
 
const char * m_license
 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.
 
size_t m_lineFuseThreshold
 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.
 
ExportNameMap m_names
 
H_OUTPUT_TYPE m_OutputType
 The output type.
 
float m_PageMargins [4]
 
int m_Paper_Dpi
 Indicates the DPI used for paper. This is set from the options dialog.
 
float m_Paper_Height
 Height for output sizing in inches.
 
float m_Paper_Width
 Width for output sizing in inches.
 
HBhvBehaviorManagerm_pBehaviorManager
 A pointer to the behavior manager.
 
HCameram_pCamera
 A pointer to the HCamera object for this output.
 
char const * m_pDWFModelName
 
void * m_pExtendedData
 A pointer to extra data needed by a HOutputHandler subclass .
 
HBaseModelm_pHBaseModel
 A pointer to the HBaseModel object for this output.
 
HBaseViewm_pHBaseView
 A pointer to the HBaseView object for this output.
 
char const * m_pHSRAOptions
 HOOPS HSRAOption string .
 
char const * m_pHTMLTemplateFile
 
char const * m_pPDFResourceDirectory
 
void * m_pPRCAsmModelFile
 
HPoint const * m_pWindowColor
 RGB color stored in xyz.
 
double m_ratio_cm_to_internal_units
 The output scaling ratio. See PrintToScale()
 
int m_Version
 The file format version desired for writing.
 
float m_Window_Height
 Height for output sizing in inches.
 
float m_Window_Width
 Width for output sizing in inches.
 

Detailed Description

HOutputHandlerOptions is used to pass data to HOutputHandler. All options are used based on the handler's needs. Specific HOutputHandler subclassed instances should document their own usage of options.

Constructor & Destructor Documentation

◆ HOutputHandlerOptions() [1/3]

HOutputHandlerOptions::HOutputHandlerOptions ( )

Constructs an HOutputHandlerOptions object.

◆ HOutputHandlerOptions() [2/3]

HOutputHandlerOptions::HOutputHandlerOptions ( HOutputHandlerOptions const *  o)
inline

Constructs an HOutputHandlerOptions object from another HOutputHandlerOptions object.

Parameters
oA pointer to the HOutputHandlerOptions object you want to copy.

◆ HOutputHandlerOptions() [3/3]

HOutputHandlerOptions::HOutputHandlerOptions ( const HOutputHandlerOptions o)
inline

Constructs an HOutputHandlerOptions object from another HOutputHandlerOptions object.

Parameters
oA reference to the HOutputHandlerOptions object you want to copy.

Member Function Documentation

◆ Init()

void HOutputHandlerOptions::Init ( HOutputHandlerOptions const *  o)

This method initializes this HOutputHandlerOptions object from using the properties of another HOutputHandlerOptions object.

Parameters
oA pointer to the HOutputHandlerOptions object you want to copy.

◆ LineFuseThreshold() [1/2]

size_t HOutputHandlerOptions::LineFuseThreshold ( ) const
inline

Gets the line fuse threshold

Returns
The line fuse threshold value

◆ LineFuseThreshold() [2/2]

void HOutputHandlerOptions::LineFuseThreshold ( size_t const  tf)
inline

Sets the line fuse threshold value.

Parameters
tfThe line fuse threshold value to set

◆ PopulateOptions()

virtual bool HOutputHandlerOptions::PopulateOptions ( )
virtual

Any application wishing to customize how the options are populated should derive from this class and overload this function.

◆ PrintToScale() [1/2]

double HOutputHandlerOptions::PrintToScale ( ) const
inline
Returns
The output scaling ratio. See PrintToScale()

◆ PrintToScale() [2/2]

void HOutputHandlerOptions::PrintToScale ( double const  r)
inline

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.

Member Data Documentation

◆ m_bActivateOnPageOpen

bool HOutputHandlerOptions::m_bActivateOnPageOpen

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

◆ m_bAVICodec

char HOutputHandlerOptions::m_bAVICodec[4]

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.

◆ m_bAVIShowCompressionDialog

bool HOutputHandlerOptions::m_bAVIShowCompressionDialog

Used in HIO_AVI. If true shows a dialog during export to allow the user to select a compression level. Defaults to true.

◆ m_bExporting2DDwf

bool HOutputHandlerOptions::m_bExporting2DDwf

2D Dwf Export uses a legacy version of Hardcopy. Set this option to true when exporting a 2D DWF file

◆ m_bHTMLIncludeMeasurementInformation

bool HOutputHandlerOptions::m_bHTMLIncludeMeasurementInformation

Whether to include measurement information when generating an HTML file from HIOUtilityPublish.

◆ m_bPrcCompressTessellation

bool HOutputHandlerOptions::m_bPrcCompressTessellation

Sets whether to compress tessellation data when exporting to the PRC format. Defaults to false.

◆ m_bPrcRemoveAttributes

bool HOutputHandlerOptions::m_bPrcRemoveAttributes

Sets whether to remove attribute data when exporting to the PRC format. Defaults to false.

◆ m_bPrcRemoveBRep

bool HOutputHandlerOptions::m_bPrcRemoveBRep

Sets whether to remove BREP data when exporting to the PRC format. Defaults to false.

◆ m_bPrcUseNameUserData

bool HOutputHandlerOptions::m_bPrcUseNameUserData

Sets whether to use the m_iPrcNameUserDataIndex field. Defaults to false.

◆ m_ePrcBrepCompression

HPrcBrepCompression HOutputHandlerOptions::m_ePrcBrepCompression

Sets the compression level for BRep data when exporting to the PRC format. Defaults to PrcBrepCompressionNone.

◆ m_fAnnotBottom

float HOutputHandlerOptions::m_fAnnotBottom

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

◆ m_fAnnotLeft

float HOutputHandlerOptions::m_fAnnotLeft

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

◆ m_fAnnotRight

float HOutputHandlerOptions::m_fAnnotRight

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

◆ m_fAnnotTop

float HOutputHandlerOptions::m_fAnnotTop

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

◆ m_iPrcNameUserDataIndex

MVO_POINTER_SIZED_INT HOutputHandlerOptions::m_iPrcNameUserDataIndex

Sets the user data index for the UTF8-encoded name to use for PRC entities when creating PRC data from a scene graph.

◆ m_names

ExportNameMap HOutputHandlerOptions::m_names

available for output handlers to map HC_KEYS to names in the output file.

◆ m_PageMargins

float HOutputHandlerOptions::m_PageMargins[4]

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

◆ m_pDWFModelName

char const* HOutputHandlerOptions::m_pDWFModelName

DWF Model name

◆ m_pHTMLTemplateFile

char const* HOutputHandlerOptions::m_pHTMLTemplateFile

Path to the template file to use when generating an HTML file from HIOUtilityPublish. This value is REQUIRED for HTML export to succeed.

◆ m_pPDFResourceDirectory

char const* HOutputHandlerOptions::m_pPDFResourceDirectory

Publish resource directory. Setting this directory is required for 3D PDF export. Normally, this directory is HOOPS_PUBLISH_INSTALL_DIR/bin/resource.

◆ m_pPRCAsmModelFile

void* HOutputHandlerOptions::m_pPRCAsmModelFile

Pointer to a PRC model


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