#include <HIOManager.h>
Public Member Functions | |
void | ActivateOnPageOpen (bool onoff) |
bool | ActivateOnPageOpen () const |
void | AnnotBottom (float f) |
float const | AnnotBottom (void) const |
void | AnnotLeft (float f) |
float const | AnnotLeft (void) const |
void | AnnotRight (float f) |
float const | AnnotRight (void) const |
void | AnnotTop (float f) |
float const | AnnotTop (void) const |
void | Ascii (bool const tf) |
Some file formats support binary and ascii such as STL. Set this to TRUE for ascii output. | |
bool | Ascii () const |
Some file formats support binary and ascii such as STL. Set this to TRUE for ascii output. | |
void | Camera (HCamera *const c) |
A pointer to the HCamera object for this output. | |
HCamera *const | Camera () const |
A pointer to the HCamera object for this output. | |
void | ConserveMemory (bool const tf) |
This option has been deprecated and has no effect. | |
bool | ConserveMemory () const |
This option has been deprecated and has no effect. | |
void | ExtendedData (HOutputHandlerOptions *const vp) |
void | ExtendedData (void *const vp) |
void *const | ExtendedData () const |
void | FastPrint (bool const tf) |
This option has been deprecated. Specifies printing method. | |
bool | FastPrint () const |
This option has been deprecated. Specifies printing method. | |
void | ForceGrayscale (bool const tf) |
Sets black and white output. | |
bool | ForceGrayscale () const |
Returns whether black and white output is enabled. | |
virtual char const * | GetType () const |
HOutputHandlerOptions (const HOutputHandlerOptions &o) | |
HOutputHandlerOptions (HOutputHandlerOptions const *o) | |
HOutputHandlerOptions () | |
void | HSRAOptions (char const *const tf) |
HOOPS HSRAOption string . | |
char const *const | HSRAOptions () const |
HOOPS HSRAOption string . | |
void | ImageDpi (int const dpi) |
Sets the DPI used for images. | |
int const | ImageDpi () const |
Returns the DPI used for images. | |
void | Init (HOutputHandlerOptions const *o) |
void | Key (HC_KEY const k) |
The HC_Key for this output. | |
HC_KEY const | Key () const |
The HC_Key for this output. | |
void | Model (HBaseModel *const m) |
A pointer to the HBaseModel object for this output. | |
HBaseModel *const | Model () const |
A pointer to the HBaseModel object for this output. | |
void | Output3d (bool const tf) |
Some file formats, such as DWF, support 2d and/or 3d output. Set this to TRUE for 3d output. Default is FALSE. | |
bool | Output3d () const |
Some file formats, such as DWF, support 2d and/or 3d output. Set this to TRUE for 3d output. | |
void | OutputType (H_OUTPUT_TYPE ot) |
The output type. | |
H_OUTPUT_TYPE | OutputType () const |
The output type. | |
void | PaperDpi (int const dpi) |
Sets the 'hardcopy resolution' HOOPS/3DGS Driver_Option. | |
int const | PaperDpi () const |
Returns the 'hardcopy resolution' HOOPS/3DGS Driver_Option. | |
void | PaperHeight (float const f) |
Set 'paper' height in inches. | |
float const | PaperHeight () const |
Returns 'paper' height in inches. | |
void | PaperWidth (float const f) |
Sets 'paper' width in inches. | |
float const | PaperWidth () const |
Returns 'paper' width in inches. | |
virtual bool | PopulateOptions () |
void | PrintToScale (double const r) |
double | PrintToScale () const |
void | StlNormals (bool const tf) |
Determines if we generate and output face normals when writing to STL file format. | |
bool | StlNormals () const |
Determines if we generate and output face normals when writing to STL file format. | |
void | UseSubscreen (bool const tf) |
Determines if HOOPS is calculating a subscreen to match the output to the size of the view window. | |
bool | UseSubscreen () const |
Determines if HOOPS is calculating a subscreen to match the output to the size of the view window. | |
void | UseWindowColor (bool const tf) |
If set to true, the background color of the view is used. | |
bool | UseWindowColor () const |
If set to true, the background color of the view is used. | |
void | Version (int const v) |
int const | Version () const |
void | View (HBaseView *const v) |
A pointer to the HBaseView object for this output. | |
HBaseView *const | View () const |
A pointer to the HBaseView object for this output. | |
void | WindowColor (HPoint const *const tf) |
Set the color of the window. The RGB color stored in xyz of HPoint. | |
HPoint const *const | WindowColor () const |
Set the color of the window. The RGB color stored in xyz of HPoint. | |
void | WindowFrame (bool const tf) |
Determines if a window frame is drawn or not. | |
bool | WindowFrame () const |
Determines if a window frame is drawn or not. | |
void | WindowHeight (float const f) |
Height for output sizing in inches. | |
float const | WindowHeight () const |
Height for output sizing in inches. | |
void | WindowWidth (float const f) |
Width for output sizing in inches. | |
float const | WindowWidth () const |
Width for output sizing in inches. | |
void | WriteAnimations (bool const tf) |
bool | WriteAnimations () const |
Public Attributes | |
bool | m_b3dOutput |
Some file formats, such as 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. | |
bool | m_bAVIShowCompressionDialog |
bool | m_bConserveMemory |
This option has been deprecated and has no effect. | |
bool | m_bFastPrint |
This option has been deprecated. Specifies printing method. | |
bool | m_bPrcCompressTessellation |
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 |
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. | |
ExportNameMap | m_names |
H_OUTPUT_TYPE | m_OutputType |
The output type. | |
float | m_PageMargins [4] |
int | m_Paper_Dpi |
Specifies the 'hardcopy resolution' HOOPS/3DGS Driver_Option. This applies to all 'paper' based output devices, which include HPGL/CGM/Postscript/2D-DWF/PDF/EMF. The default is 300. | |
float | m_Paper_Height |
Specifies the height of the 'paper', for HIO modules that export to a 'paper' based output devices, which include HPGL/CGM/Postscript/2D-DWF/PDF/EMF. Default is 11.0. | |
float | m_Paper_Width |
Specifies the width of the 'paper', for HIO modules that export to 'paper' based output devices, which include HPGL/CGM/Postscript/2D-DWF/PDF/EMF. Default is 8.5. | |
HBhvBehaviorManager * | m_pBehaviorManager |
A pointer to the behavior manager. | |
HCamera * | m_pCamera |
A pointer to the HCamera object for this output. | |
char const * | m_pDWFModelName |
void * | m_pExtendedData |
A convenience pointer to extra data which may be needed by an HOutputHandler subclass. | |
HBaseModel * | m_pHBaseModel |
A pointer to the HBaseModel object for this output. | |
HBaseView * | m_pHBaseView |
A pointer to the HBaseView object for this output. | |
char const * | m_pHSRAOptions |
HOOPS HSRAOption string . | |
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 |
float | m_Window_Width |
HOutputHandlerOptions::HOutputHandlerOptions | ( | ) |
Constructs an HOutputHandlerOptions object.
HOutputHandlerOptions::HOutputHandlerOptions | ( | HOutputHandlerOptions const * | o | ) | [inline] |
Constructs an HOutputHandlerOptions object from another HOutputHandlerOptions object.
o | A pointer to the HOutputHandlerOptions object you want to copy. |
HOutputHandlerOptions::HOutputHandlerOptions | ( | const HOutputHandlerOptions & | o | ) | [inline] |
Constructs an HOutputHandlerOptions object from another HOutputHandlerOptions object.
o | A reference to the HOutputHandlerOptions object you want to copy. |
void HOutputHandlerOptions::Init | ( | HOutputHandlerOptions const * | o | ) |
This method initializes this HOutputHandlerOptions object using the properties of another HOutputHandlerOptions object.
o | A pointer to the HOutputHandlerOptions object you want to copy. |
virtual bool HOutputHandlerOptions::PopulateOptions | ( | ) | [virtual] |
Any application wishing to customize how the options are populated should derive from this class and overload this function.
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:
Behavioral Notes:
The default value is 0, which indicates to not print-to-scale.
double HOutputHandlerOptions::PrintToScale | ( | ) | const [inline] |
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
Used in HIO_AVI. If true shows a dialog during export to allow the user to select a compression level. Defaults to true.
Sets whether to compress tessellation data when exporting to the PRC format. Defaults to false.
Sets the compression level for BRep data when exporting to the PRC format. Defaults to PrcBrepCompressionNone.
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
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
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
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
Specifies the DPI of the output device for output handlers that export to image formats (JPG/PNG/TIFF/GIF). The default is 100 (The size of the image will be m_Image_Dpi * (m_Window_Width, m_Window_Height) )
If your text is not visible, increase m_Image_Dpi
available for output handlers to map HC_KEYS to names in the output file.
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
char const* HOutputHandlerOptions::m_pDWFModelName |
DWF Model name
Pointer to a PRC model
This has different meanings depending on whether the output handler is HOutputHandlerStyleImage or HOutputHandlerStyleModel For HOutputHandlerStyleImage, it specifies the height of the image in inches. For HOutputHandlerStyleModel, it is used to determine the aspect ratio of the HOOPS window so it will properly be displayed WYSIWYG on the output device. If the value is <=0, the window be expanded to fit the full height of the output device. Default value is 0
This has different meanings depending on whether the output handler is HOutputHandlerStyleImage or HOutputHandlerStyleModel For HOutputHandlerStyleImage, it specifies the width of the image in inches. For HOutputHandlerStyleModel, it is used to determine the aspect ratio of the HOOPS window so it will properly be displayed WYSIWYG on the output device. If the value is <=0, the window be expanded to fit the full width of the output device. Default value is 0