The HBaseModel class is used to store and manage model information. More...
#include <HBaseModel.h>
Public Member Functions | |
virtual void | CleanIncludes () |
virtual void | CreateIncludeSegment () |
virtual void | DeleteIncludedSegments () |
virtual void | Flush () |
virtual HC_KEY | GetBBoxKey () const |
virtual HBhvBehaviorManager * | GetBhvBehaviorManager () |
TK_Dispatch_XML * | GetDispatchXML () |
HEventManager * | GetEventManager () |
bool | GetFileLoadComplete () const |
bool | GetFirstFitComplete () const |
HModelInfo * | GetHModelInfo () const |
bool | GetLMVModel () const |
virtual HC_KEY | GetModelIncludeKey () const |
virtual HC_KEY | GetModelKey () const |
bool | GetObjectCheck () const |
bool | GetStaticModel () const |
bool | GetStaticModelOn () const |
virtual HStreamFileToolkit * | GetStreamFileTK () const |
HBaseModel (char const *model=0) | |
virtual void | Init () |
virtual bool | IsBRepGeometry () const |
virtual bool | IsFEAGeometry () const |
virtual bool | IsVectorGeometry () const |
void | MakeAnimationSnapshot (int tick) |
virtual HFileInputResult | Read (const __wchar_t *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 | SetLMVModel (bool value) |
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 __wchar_t *FileName, HBaseView *pHView=0, float width=0, float height=0) |
virtual HFileOutputResult | Write (const char *FileName, HBaseView *pHView=0, float width=0, float height=0) |
virtual HFileOutputResult | WriteWithAnimation (const __wchar_t *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 __wchar_t *FileName, HBaseView *pHView=0, HOutputHandlerOptions *options=0) |
virtual HFileOutputResult | WriteWithOptions (const char *FileName, HBaseView *pHView=0, HOutputHandlerOptions *options=0) |
virtual | ~HBaseModel () |
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 |
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.
HBaseModel::HBaseModel | ( | char const * | model = 0 | ) |
Constructs an HBaseModel object.
virtual HBaseModel::~HBaseModel | ( | ) | [virtual] |
Deletes the HOOPS segment tree associated with the model.
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 | ( | ) | const [inline, virtual] |
References HC_KEY.
virtual HBhvBehaviorManager* HBaseModel::GetBhvBehaviorManager | ( | ) | [virtual] |
TK_Dispatch_XML* HBaseModel::GetDispatchXML | ( | ) |
HEventManager* HBaseModel::GetEventManager | ( | ) |
bool HBaseModel::GetFileLoadComplete | ( | ) | const [inline] |
bool HBaseModel::GetFirstFitComplete | ( | ) | const [inline] |
HModelInfo* HBaseModel::GetHModelInfo | ( | ) | const |
bool HBaseModel::GetLMVModel | ( | ) | const |
Returns the existence of a LMV model at the root of the model segment.
virtual HC_KEY HBaseModel::GetModelIncludeKey | ( | ) | const [inline, virtual] |
References HC_KEY.
virtual HC_KEY HBaseModel::GetModelKey | ( | ) | const [inline, virtual] |
References HC_KEY.
bool HBaseModel::GetObjectCheck | ( | ) | const [inline] |
bool HBaseModel::GetStaticModel | ( | ) | const |
Returns the existence of a static model at the root of the model segment.
bool HBaseModel::GetStaticModelOn | ( | ) | const |
Returns if a static model is requested at the root of the model segment.
virtual HStreamFileToolkit* HBaseModel::GetStreamFileTK | ( | ) | const [inline, virtual] |
virtual void HBaseModel::Init | ( | ) | [virtual] |
Initializes an HBaseModel object.
virtual bool HBaseModel::IsBRepGeometry | ( | ) | const [inline, virtual] |
virtual bool HBaseModel::IsFEAGeometry | ( | ) | const [inline, virtual] |
virtual bool HBaseModel::IsVectorGeometry | ( | ) | const [inline, virtual] |
virtual HFileInputResult HBaseModel::Read | ( | const __wchar_t * | 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.
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. |
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::SetLMVModel | ( | bool | value | ) |
Sets the LMV model status at the root of the model segment.
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.
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 __wchar_t * | FileName, |
HBaseView * | pHView = 0 , |
||
float | width = 0 , |
||
float | height = 0 |
||
) | [virtual] |
Writes the contents of the HOOPS segment tree to a file. The HOOPS segment tree beginning with the segment denoted by m_ModelKey will be written. The HIO handler registered to handle the specified file extension will be used for export. See the list of Supported Export formats here: http://docs.techsoft3d.com/visualize/HoopsMVO/SupportedFileFormats.html
This function should be overloaded to support writing of additional file types.
FileName | A character pointer denoting the name of the file to write |
pHView | A pointer to the HBaseView object containing the view-dependent information |
width | For 2D or 'paper' export formats, the m_Window_Width and m_Paper_Width are set to 'width'. For image formats, the width of the actual image in pixels will be 'width' * m_Image_Dpi. Default is 0. |
height | For 2D or 'paper' export formats, the m_Window_Height and m_Paper_Height are set to 'height'. For image formats, the height of the actual image in pixels will be 'height' * m_Image_Dpi. Default is 0. |
virtual HFileOutputResult HBaseModel::WriteWithOptions | ( | const __wchar_t * | FileName, |
HBaseView * | pHView = 0 , |
||
HOutputHandlerOptions * | options = 0 |
||
) | [virtual] |
+ Reads the visualization contents of the file into the HOOPS segment tree (visualization contents refers to graphical information/attributes). The segment tree will be created underneath the segment denoted by m_ModelKey. The HIO handler registered to handle the specified file extension will be used for import. See the list of Supported Import formats here: http://docs.techsoft3d.com/visualize/HoopsMVO/SupportedFileFormats.html
This function can be overloaded to support reading of additional file types.
FileName | A character pointer denoting the name of the file to write |
pHView | A pointer to the HBaseView object containing the view-dependent information |
options | An optional pointer to an instance of a HOutputHandlerOptions contain extra data for output operation. |
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.
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 [mutable, protected] |
A pointer to the HModelInfo object.