Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HBaseModel Class Reference

The HBaseModel class is used to store and manage model information. More...

#include <HBaseModel.h>

List of all members.

Public Member Functions

virtual void CleanIncludes ()
virtual void DeleteIncludedSegments ()
virtual void Flush ()
virtual HC_KEY GetBBoxKey ()
virtual HBhvBehaviorManager * GetBhvBehaviorManager ()
TK_Dispatch_XML * GetDispatchXML ()
HEventManager * GetEventManager ()
bool GetFileLoadComplete ()
bool GetFirstFitComplete ()
HModelInfo * GetHModelInfo ()
virtual HC_KEY GetModelIncludeKey ()
virtual HC_KEY GetModelKey ()
bool GetObjectCheck ()
bool GetStaticModel ()
virtual HStreamFileToolkit * GetStreamFileTK ()
 HBaseModel ()
virtual void Init ()
virtual bool IsBRepGeometry ()
virtual bool IsFEAGeometry ()
virtual bool IsVectorGeometry ()
void MakeAnimationSnapshot (int tick)
bool NeedsStencilBuffer ()
virtual HFileInputResult Read (const unsigned short *FileName, HBaseView *pHView=0, bool clean_include=true, HInputHandlerOptions *options=0)
virtual HFileInputResult Read (const char *FileName, HBaseView *pHView=0, bool clean_include=true, HInputHandlerOptions *options=0)
void SetBhvBehaviorManager (HBhvBehaviorManager *BehaviorManager)
virtual void SetBRepGeometry (bool brep)
virtual void SetFEAGeometry (bool fea)
void SetFileLoadComplete (bool value, HBaseView *pHView=0)
void SetFirstFitComplete (bool value)
void SetNeedsStencilBuffer ()
void SetObjectCheck (bool value)
void SetStaticModel (bool value)
virtual void SetVectorGeometry (bool vector)
void Update (bool antialias=false, bool forceUpdate=false)
virtual HFileOutputResult Write (const char *FileName, HBaseView *pHView=0, float width=0, float height=0)
virtual HFileOutputResult WriteWithAnimation (const char *FileName, HBaseView *pHView=0, float width=0, float height=0)
virtual HFileOutputResult WriteWithOptions (const char *FileName, HBaseView *pHView=0, HOutputHandlerOptions *options=0)
virtual ~HBaseModel ()

Protected Member Functions

virtual void CreateIncludeSegment ()

Protected Attributes

HC_KEY m_BBoxKey
bool m_bBRepGeometry
bool m_bFEAGeometry
bool m_bFileLoadComplete
bool m_bFirstFitComplete
bool m_bNeedsStencilBuffer
bool m_bObjectCheck
bool m_bVectorGeometry
HC_KEY m_ModelIncludeKey
HC_KEY m_ModelKey
HBhvBehaviorManager * m_pBhvBehaviorManager
TK_Dispatch_XML * m_pDispatchXML
HEventManager * m_pEventManager
HStreamFileToolkit * m_pHFile
HBhvKeyframeGenerator * m_pKeyframeGenerator
HModelInfo * m_pModelInfo
HBhvSegmentTracker * m_pSegmentTracker

Static Protected Attributes

static unsigned long m_ModelCount

Detailed Description

The HBaseModel class is used to store and manage model information.

HBaseModel provides functions which facilitate creation and management of the graphical information associated with the model. It is typically referenced by an HBaseView object, which defines a specific view of the model.

The class encapsulates a HOOPS Include Library segment. This segment is intended to be used as the root of a HOOPS tree containing segments and geometry which represent graphical information for the application-specific model. A file can be read into it, or geometry can be created within a segment hierarchy beneath it.

Constructor & Destructor Documentation

HBaseModel::HBaseModel (  ) 

Constructs an HBaseModel object.

virtual HBaseModel::~HBaseModel (  )  [virtual]

Deletes the HOOPS segment tree associated with the model.

Member Function Documentation

virtual void HBaseModel::CleanIncludes (  )  [virtual]

Utility function which moves global includes to model specific include segments.

virtual void HBaseModel::DeleteIncludedSegments (  )  [virtual]

Scans for all the segments which are included by the model and deletes them.

virtual void HBaseModel::Flush (  )  [virtual]

Flushes the HOOPS segment tree associated with the HBaseModel object.

virtual HC_KEY HBaseModel::GetBBoxKey (  )  [inline, virtual]

Returns:
The key of the HOOPS segment containing the model's bounding box geometry.

References HC_KEY.

virtual HBhvBehaviorManager* HBaseModel::GetBhvBehaviorManager (  )  [virtual]

Returns:
A pointer to the HBhvBehaviorManager object.

TK_Dispatch_XML* HBaseModel::GetDispatchXML (  ) 

Returns:
A pointer to the DispatchXML object which allows registering of multiple xml handlers.

HEventManager* HBaseModel::GetEventManager (  ) 

Returns:
A pointer to the HEventManager object.

bool HBaseModel::GetFileLoadComplete (  )  [inline]

Returns:
A boolean indicating whether a Read() has completed.

bool HBaseModel::GetFirstFitComplete (  )  [inline]

Returns:
A boolean indicating whether HBaseModel has called FitWorld on this model after the last call to Read(). It is not useful for model with multiple views.

HModelInfo* HBaseModel::GetHModelInfo (  ) 

Returns:
A pointer to the HModelInfo object with the current model info.

virtual HC_KEY HBaseModel::GetModelIncludeKey (  )  [inline, virtual]

Returns:
The key of the encapsulated HOOPS segment denoting the top of the model's include segment hierarchy.

References HC_KEY.

virtual HC_KEY HBaseModel::GetModelKey (  )  [inline, virtual]

Returns:
The key of the encapsulated HOOPS segment denoting the top of the model hierarchy .

References HC_KEY.

bool HBaseModel::GetObjectCheck (  )  [inline]

Returns:
A boolean indicating whether to scan model for annotations and other objects.

bool HBaseModel::GetStaticModel (  ) 

Returns the existence of a static model at the root of the model segment.

virtual HStreamFileToolkit* HBaseModel::GetStreamFileTK (  )  [inline, virtual]

Returns:
A pointer to the stream toolkit object used with this model for writing and reading HSF files.

virtual void HBaseModel::Init (  )  [virtual]

Initializes an HBaseModel object.

virtual bool HBaseModel::IsBRepGeometry (  )  [inline, virtual]

Returns:
A boolean indicating whether data originated from a CAD dataset. This is used so that we do not use HOOPS' edges for display but rather the polylines which are provided by the modeller. This is set by setting a User_Option of 1 in the root of your scene-graph. This is automatically set if the data originated from ACIS or Parasolid and you used the framework to generate the file.

virtual bool HBaseModel::IsFEAGeometry (  )  [inline, virtual]

Returns:
A boolean indicating whether data originated from a FEA dataset. Developers ensure that this flag is automatically set if a User_Option of 2 is set in the root node of their scene-graph.

virtual bool HBaseModel::IsVectorGeometry (  )  [inline, virtual]

Returns:
A boolean indicating whether the data is only vector data. This allows HOOPS to force vector printing always and not turn on shading. This is set by setting a User_Option of 3 in the root of your scene-graph.

bool HBaseModel::NeedsStencilBuffer (  )  [inline]

Returns:
True if a stencil buffer needs to be requested prior to the first update.

virtual HFileInputResult HBaseModel::Read ( const unsigned short *  FileName,
HBaseView *  pHView = 0,
bool  clean_include = true,
HInputHandlerOptions *  options = 0 
) [virtual]

Based on file extention this method loads the content of a file using HInputHandler found in the HIOManager from HDB. If no handler is found, it will return InputNotHandled. It does not Flush existing geometry. The default extention is hmf if no other is found.

Parameters:
FileName A character pointer denoting the UNICODE name of the file to be read in
pHView A pointer to the HBaseView object containing the view-dependent information reading in the model
clean_include If true then includes are moved to unique include location after loading
options An optional pointer to an instance of a HInputHandlerOptions contain extra data for input operation.
Returns:
HFileInputResult with result of the attempted file read.

virtual HFileInputResult HBaseModel::Read ( const char *  FileName,
HBaseView *  pHView = 0,
bool  clean_include = true,
HInputHandlerOptions *  options = 0 
) [virtual]

Based on file extention this method loads the content of a file using HInputHandler found in the HIOManager from HDB If no handler is found, it will return InputNotHandled. It does not Flush existing geometry. The default extention is hmf if no other is found.

Parameters:
FileName A character pointer denoting the name of the file to be read in
pHView A pointer to the HBaseView object containing the view-dependent information reading in the model
clean_include if true, then includes are moved to unique include location after loading
options An optional pointer to an instance of a HInputHandlerOptions contain extra data for input operation.
Returns:
HFileInputResult with result of the attempted file read.

void HBaseModel::SetBhvBehaviorManager ( HBhvBehaviorManager *  BehaviorManager  ) 

Sets the HBhvBehaviorManager object.

virtual void HBaseModel::SetBRepGeometry ( bool  brep  )  [inline, virtual]

This method indicates if this model represents geometric modeler data but wasn't necessarily loaded from the modelling kernel. Pass true if yes and false if otherwise.

virtual void HBaseModel::SetFEAGeometry ( bool  fea  )  [inline, virtual]

This method indicates if the model represents finite-element data. Pass true if yes and false if otherwise.

void HBaseModel::SetFileLoadComplete ( bool  value,
HBaseView *  pHView = 0 
)

Sets the boolean indicating whether a Read() has completed.

void HBaseModel::SetFirstFitComplete ( bool  value  )  [inline]

Sets the boolean indicating whether the first call to FitWorld has been performed.

void HBaseModel::SetNeedsStencilBuffer (  )  [inline]

Allows the StencilProbe class to inform the model of its presence.

void HBaseModel::SetObjectCheck ( bool  value  )  [inline]

Sets the boolean indicating whether to scan model for annotations and other objects.

void HBaseModel::SetStaticModel ( bool  value  ) 

Sets the static model status at the root of the model segment.

virtual void HBaseModel::SetVectorGeometry ( bool  vector  )  [inline, virtual]

This method indicates if the model only contains vector data. Pass true if yes and false if otherwise.

void HBaseModel::Update ( bool  antialias = false,
bool  forceUpdate = false 
)

Performs a rendering update.

Parameters:
antialias If true, then an anti-aliased version of the scene will be drawn.
forceUpdate If true, then an update will be forced.

virtual HFileOutputResult HBaseModel::Write ( const char *  FileName,
HBaseView *  pHView = 0,
float  width = 0,
float  height = 0 
) [virtual]

Writes the contents of the HOOPS Include Library tree to a file. The file extension denotes the file type: hmf = HOOPS Metafile, tif = TIFF Image file, ps = Postscript. hsf = HOOPS Stream File.

This function should be overloaded to support writing of additional file types.

Parameters:
FileName A character pointer denoting the name of the file to write
pHView A pointer to the HBaseView object containing the view-dependent information writing out the model
width An integer denoting the width in inches
height An integer denoting the height in inches
Returns:
HFileOutputResult with result of the attempted file write.

virtual HFileOutputResult HBaseModel::WriteWithOptions ( const char *  FileName,
HBaseView *  pHView = 0,
HOutputHandlerOptions *  options = 0 
) [virtual]

Writes the contents of the HOOPS Include Library tree to a file. The file extension denotes the file type: hmf = HOOPS Metafile, tif = TIFF Image file, ps = Postscript. hsf = HOOPS Stream File.

This function should be overloaded to support writing of additional file types.

Parameters:
FileName A character pointer denoting the name of the file to write
pHView A pointer to the HBaseView object containing the view-dependent information writing out the model
options An optional pointer to an instance of a HOutputHandlerOptions contain extra data for output operation.
Returns:
HFileOutputResult with result of the attempted file write.

Member Data Documentation

HC_KEY HBaseModel::m_BBoxKey [protected]

Key of the HOOPS segment containing model's bounding box geometry.

bool HBaseModel::m_bBRepGeometry [protected]

Set this value to true if the model represents geometric modeler data but wasn't necessarily loaded from the modelling kernel.

bool HBaseModel::m_bFEAGeometry [protected]

Set this value to true if the model represents finite-element data.

bool HBaseModel::m_bFileLoadComplete [protected]

Utility member intended to be set to true if the model is being streamed in and the file has finished loading in.

bool HBaseModel::m_bFirstFitComplete [protected]

Utility member intended to be set to true if the model is being streamed in and the first 'fit scene to camera' has occurred.

bool HBaseModel::m_bNeedsStencilBuffer [protected]

Set this value to true if the model contains a CuttingAnimation XML behavior (see: StencilProbe).

bool HBaseModel::m_bObjectCheck [protected]

Utility member intended to be set to true if the model is to be scanned for annotations and other "objects"

bool HBaseModel::m_bVectorGeometry [protected]

Set this value to true if the model only contains vector data.

unsigned long HBaseModel::m_ModelCount [static, protected]

Integer denoting the number of created model objects.

HC_KEY HBaseModel::m_ModelIncludeKey [protected]

Key of the HOOPS segment denoting the top of model include hierarchy.

HC_KEY HBaseModel::m_ModelKey [protected]

Key of the HOOPS segment denoting the top of model hierarchy.

HBhvBehaviorManager* HBaseModel::m_pBhvBehaviorManager [protected]

A pointer to the HBhvBehaviorManager object.

TK_Dispatch_XML* HBaseModel::m_pDispatchXML [protected]

Pointer to the Dispatch XML object.

HEventManager* HBaseModel::m_pEventManager [protected]

A pointer to the HEventManager object.

HStreamFileToolkit* HBaseModel::m_pHFile [protected]

A pointer to the HStreamFileToolkit object.

HModelInfo* HBaseModel::m_pModelInfo [protected]

A pointer to the HModelInfo object.

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