Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HOutputHandlerOptions Class Reference

#include <HIOManager.h>

List of all members.

Public Member Functions

bool ActivateOnPageOpen () const
void ActivateOnPageOpen (bool onoff)
float const AnnotBottom (void) const
void AnnotBottom (float f)
float const AnnotLeft (void) const
void AnnotLeft (float f)
float const AnnotRight (void) const
void AnnotRight (float f)
float const AnnotTop (void) 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.
HCamera *const Camera () 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 *const ExtendedData () const
void ExtendedData (void *const vp)
void ExtendedData (HOutputHandlerOptions *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
 Returns whether black and white output is enabled.
void ForceGrayscale (bool const tf)
 Sets black and white output.
virtual char const * GetType () const
 HOutputHandlerOptions ()
 HOutputHandlerOptions (HOutputHandlerOptions const *o)
 HOutputHandlerOptions (const HOutputHandlerOptions &o)
char const *const HSRAOptions () const
 HOOPS HSRAOption string .
void HSRAOptions (char const *const tf)
 HOOPS HSRAOption string .
int const ImageDpi () const
 Returns the DPI used for images.
void ImageDpi (int const dpi)
 Sets the DPI used for images.
void Init (HOutputHandlerOptions const *o)
HC_KEY const Key () const
 The HC_Key for this output.
void Key (HC_KEY const k)
 The HC_Key for this output.
HBaseModel *const Model () 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 DWF, support 2d and/or 3d output. Set this to TRUE for 3d 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.
H_OUTPUT_TYPE OutputType () const
 The output type.
void OutputType (H_OUTPUT_TYPE ot)
 The output type.
int const PaperDpi () const
 Returns the 'hardcopy resolution' HOOPS/3DGS Driver_Option.
void PaperDpi (int const dpi)
 Sets the 'hardcopy resolution' HOOPS/3DGS Driver_Option.
float const PaperHeight () const
 Returns 'paper' height in inches.
void PaperHeight (float const f)
 Set 'paper' height in inches.
float const PaperWidth () const
 Returns 'paper' width in inches.
void PaperWidth (float const f)
 Sets 'paper' width 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 const Version () const
void Version (int const v)
HBaseView *const View () 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 *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 const WindowHeight () const
 Height for output sizing in inches.
void WindowHeight (float const f)
 Height for output sizing in inches.
float const 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

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.
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_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.
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 convenience pointer to extra data which may be needed by an 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 .
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

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::HOutputHandlerOptions ( )

Constructs an HOutputHandlerOptions object.

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::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

void HOutputHandlerOptions::Init ( HOutputHandlerOptions const *  o)

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

Parameters:
oA 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.

double HOutputHandlerOptions::PrintToScale ( ) const [inline]
Returns:
The output scaling ratio. See PrintToScale()
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

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.* /*! 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.

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

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

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) )

Note:
To make a 640x480, 100dpi image, set m_Image_Dpi=100 (default), m_Window_Width=6.4, m_Window_Height=4.8
If your text is not visible, increase m_Image_Dpi

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

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

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


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