HBaseView Class Reference

The HBaseView class defines and manages a view of model information. More...

#include <HBaseView.h>

List of all members.

Public Types

enum HAnimateMode { HAnimateScene = 0x00000001 }

Public Member Functions

virtual void AdjustAxisWindow (int axis_window_pixels_in=-1, HIntRectangle *rect_in=0)

virtual void Animate (int animation_steps=30, HAnimateMode animate_flags=HAnimateScene, int MaxRotation=360)

void BeginShellSelection ()

virtual void CameraPositionChanged (bool emit_message=false, bool smooth_camera_transition=false)

void cleanupSimpList ()

virtual void ClearGeometryChanged ()

void ClearUpdateRequest ()

virtual void DeleteByKeyFromMessage (const char *in_data, unsigned int data_length)

virtual void DeleteSelectionList (bool emit_message=false)

virtual void DeleteSelectionListFromMessage ()

virtual void DeSelectAllFromMessage ()

virtual void DoDynamicHighlighting (HPoint mouse_pos)

virtual void EmitDeleteByKeyMessage (HC_KEY key)

virtual void EmitDeleteSelectionListMessage ()

virtual void EmitDeSelectAllMessage ()

virtual void EmitFlushMessage ()

virtual void EmitHSFData (const char *segment, const char *in_data, unsigned int data_length)

virtual void EmitSegment (HC_KEY key, bool emit_contents_only=false)

virtual void EmitSelectMessage (HC_KEY key, bool isSelect)

virtual void EmitSetModellingMatrixMessage ()

virtual void EmitSetModellingMatrixMessage (HC_KEY key)

bool EmittingMessages ()

void EnableTargetFrameRate (bool enable=true, int target=100, int threshold=10, int steps=5)

void EndShellSelection ()

virtual HFileInputResult FileInput (const unsigned short *FileName, HInputHandler *handler, HInputHandlerOptions *options=0)

virtual HFileInputResult FileInput (const char *FileName, HInputHandler *handler, HInputHandlerOptions *options=0)

virtual HFileOutputResult FileOutput (const char *FileName, HOutputHandler *handler, HOutputHandlerOptions *options=0)

void FitSegment (HC_KEY seg_key)

void FitSelection (HC_KEY key=INVALID_KEY)

virtual void FitWorld (HPoint *center_out=0)

virtual void FitWorldExact (HPoint *center_out=0)

virtual void Flush (bool emit_message=false)

virtual void FlushFromMessage (const char *in_data, unsigned int data_length)

void FlushProgressBar ()

virtual void ForceUpdate ()

virtual bool GeometryChanged ()

bool GetAllowInteractiveCutGeometry ()

bool GetAllowInteractiveShadows ()

bool GetAnnotationResize ()

HUtilityAntialiasing * GetAntialiasing ()

AxisMode GetAxisMode ()

HC_KEY GetAxisTriadKey ()

bool GetBackplaneCulling ()

HC_KEY GetBBoxGeometryKey (void)

virtual void GetCamera (HCamera *camera)

virtual void GetCamera (HPoint *pos, HPoint *tar, HPoint *up, float &fieldx, float &fieldy, char *proj)

virtual bool GetCameraChanged ()

bool GetColorIndexInterpolation (char *option=0)

HConstantFrameRate * GetConstantFrameRateObject (void)

HC_KEY GetConstructionKey (void)

bool GetCPFaceVisibility ()

bool GetCPLineVisibility ()

int GetCullingThreshold ()

HBaseOperator * GetCurrentOperator ()

HCutGeometryVisibility GetCutGeometryVisibility ()

HC_KEY GetCuttingPlaneGeomKey (void)

bool GetCuttingPlaneRegenerationMode ()

bool GetCuttingPlanesExist (const char *plane=0)

HC_KEY GetCuttingPlanesKey (void)

bool GetCuttingPlanesVisibility ()

class HDebugZBuffer * GetDebugZBuffer ()

HC_KEY GetDefaultLightKey (void)

virtual float GetDefaultSelectionProximity ()

virtual bool GetDetailSelectionMode ()

bool GetDisplayListMode ()

DisplayListType GetDisplayListType ()

const char * GetDriverPath (void)

const char * GetDriverType (void)

bool GetDynamicHighlighting ()

HBaseViewEmitMessageFunction GetEmitMessageFunction ()

void * GetEmitMessageFunctionUserData ()

void(* GetEventCheckerCallback ())(struct ht_net_rendition *nr)

HEventManager * GetEventManager ()

bool GetFirstUpdate ()

bool GetForceFastHiddenLine ()

HandednessMode GetHandedness ()

virtual HBaseOperator * GetHandleOperator ()

virtual bool GetHasObjects ()

bool GetHideOverlappedText ()

virtual const
HSelectionHighlightMode GetHighlightMode ()

HSelectionSet * GetHighlightSelection ()

HObjectManager * GetHObjectManager ()

float GetIdleTime (void)

HC_KEY GetIncludeLinkKey (void)

bool GetInitialCameraSet ()

HC_KEY GetIntersectPolylinesKey (void)

virtual bool GetInvertMouseWheelZoom ()

ViewMode GetIsoDefault ()

bool GetKeyState (unsigned int key, int &flags)

bool(* GetKeyStateCallback ())(unsigned int, int &)

HC_KEY GetLightsKey (void)

bool GetLineAntialiasing ()

bool GetLodMode ()

int GetLodThreshold ()

HMarkupManager * GetMarkupManager ()

float GetMaximumUpdateTime ()

HBaseModel * GetModel ()

HC_KEY GetModelKey ()

HBaseOperator * GetOperator ()

HC_KEY GetOverwriteKey (void)

HandednessMode GetPolygonHandednessMode ()

HC_KEY GetProgressBarKey (void)

ProjMode GetProjMode ()

HQuickMovesMethod GetQuickMovesMethod () const

bool GetRecordMode ()

virtual int GetRelatedSelectionLimit ()

HRenderMode GetRenderMode ()

bool GetSceneBoundingSet ()

void GetSceneExtents (HPoint &min, HPoint &max)

HC_KEY GetSceneKey (void)

HSelectionSet * GetSelection (void)

HShadowMode GetShadowMode ()

bool GetShadowRegenerationMode ()

HShadowRenderingMode GetShadowRenderingMode ()

HSharedKey * GetSharedKey ()

bool GetSmoothTransition ()

float GetSmoothTransitionDuration ()

bool GetSpritingMode ()

class HStencilProbe * GetStencilProbe ()

bool GetSuppressUpdate ()

bool GetTextAntialiasing ()

bool GetTransparentSelectionBoxMode ()

HUndoManager * GetUndoManager ()

int GetUpdateInterrupted ()

bool GetUpdateRequested ()

void GetViewAxis (HVector *front_axis, HVector *top_axis)

HC_KEY GetViewKey (void)

ViewMode GetViewMode ()

HViewSelectionLevel GetViewSelectionLevel ()

ViewUpdateMode GetViewUpdateMode ()

virtual bool GetVisibilitySelectionMode ()

void GetWindowColor (HPoint &color_top, HPoint &color_bottom, int &percentage)

void GetWindowColor (HPoint &color_top, HPoint &color_bottom)

void GetWindowColor (HPoint &color_out)

void * GetWindowHandle ()

HC_KEY GetWindowspaceKey (void)

int GetXSize ()

int GetYSize ()

float GetZoomLimit (void)

void HasInitialView (bool does_it)

bool HasInitialView ()

HBaseView (HBaseModel *model, const char *alias=0, const char *driver_type=0, const char *instance_name=0, void *window_handle=0, void *colormap=0, void *clip_override=0, void *window_handle_2=0, const char *driver_path=0)

virtual void Init ()

void InitAntialiasing ()

void InjectEvent (HEventInfo hevent)

virtual void InsertHSFData (const char *segment, const char *in_data, unsigned int data_length, bool emit_message=false)

virtual void InsertHSFDataFromMessage (const char *in_data, unsigned int data_length)

virtual void InternalUpdate ()

void InvalidateSceneBounding ()

bool IsFrameRateEnabled ()

bool IsLightFollowCamera ()

void Notify (int signal, void *signal_data=0)

int ObjectMovedEvent (HBaseView *view, HC_KEY key, HPoint *pos)

virtual int OnKeyDown (HEventInfo &hevent)

virtual int OnKeyUp (HEventInfo &hevent)

virtual int OnLButtonDblClk (HEventInfo &hevent)

virtual int OnLButtonDown (HEventInfo &hevent)

virtual int OnLButtonDownAndMove (HEventInfo &hevent)

virtual int OnLButtonUp (HEventInfo &hevent)

virtual int OnLRButtonDownAndMove (HEventInfo &hevent)

virtual int OnMButtonDownAndMove (HEventInfo &hevent)

virtual int OnMouseMove (HEventInfo &hevent)

virtual int OnMouseWheel (HEventInfo &hevent)

virtual int OnNoButtonDownAndMove (HEventInfo &hevent)

virtual int OnRButtonDownAndMove (HEventInfo &hevent)

virtual void PrepareForCameraChange ()

void RebindView (const char *alias=0, const char *driver_type=0, const char *instance_name=0, void *window_handle=0, void *colormap=0, void *clip_override=0, void *window_handle_2=0, int debug_flags=0)

void RemoveTransforms ()

void RenderAntialiasing ()

void RenderBRepHiddenLine ()

void RenderBRepHiddenLineFast ()

void RenderBRepWireframe ()

void RenderFlat ()

void RenderGouraud ()

void RenderGouraudWithLines ()

void RenderHiddenLine ()

void RenderHiddenLineFast ()

void RenderLOD1 ()

void RenderLOD2 ()

void RenderPhong ()

void RenderShaded ()

void RenderShadedVertices ()

void RenderShadedWireframe ()

void RenderShadedWithLines ()

void RenderSilhouette ()

void RenderVertices ()

void RenderWireframe ()

void RenderWireframeWithSilhouette ()

void RequestUpdate ()

void ResetIdleTime (void)

void ResetKeyState ()

void RotateOnUpdate (const char *sname)

virtual void SelectFromMessage (const char *in_data, unsigned int data_length)

void SetAllowInteractiveCutGeometry (bool onoff)

void SetAllowInteractiveShadows (bool onoff)

void SetAnnotationResize (bool value)

virtual void SetAxisManipulateOperator (HOpCameraManipulate *op)

void SetAxisMode (AxisMode mode)

void SetBackplaneCulling (bool cull)

void SetBBoxGeometryKey (HC_KEY bbox_key)

virtual void SetCamera (HCamera camera)

virtual void SetCamera (HPoint pos, HPoint tar, HPoint up, float fieldx, float fieldy, char *proj)

virtual void SetCameraChanged (bool val=true)

virtual void SetCameraFromMessage (const char *data, unsigned int data_length)

void SetColorIndexInterpolation (bool onoff, bool isolines=false)

void SetColorInterpolation (bool onoff)

void SetConstantFrameRateObject (HConstantFrameRate *cf)

void SetConstructionKey (HC_KEY construct_key)

void SetCPGeomVisibility (bool lines, bool faces=false)

void SetCullingThreshold (int cullingthreshold)

void SetCurrentOperator (HBaseOperator *NewOperator)

void SetCutGeometryVisibility (HCutGeometryVisibility visibility)

void SetCuttingPlaneGeomKey (HC_KEY cuttingplanegeom_key)

virtual void SetCuttingPlaneRegenerationMode (bool onoff)

void SetCuttingPlanesExist (bool state)

void SetCuttingPlanesKey (HC_KEY cuttingplanes_key)

void SetCuttingPlanesVisibility (bool visible)

void SetDebugZBuffer (HDebugZBuffer *dzb)

void SetDefaultHSRA ()

virtual void SetDefaultSelectionProximity (float selectionproximity)

virtual void SetDetailSelection (bool onoff)

void SetDisplayHandlesOnDblClk (bool dh)

void SetDisplayListMode (bool mode)

void SetDisplayListType (DisplayListType type)

void SetDynamicHighlighting (bool state)

void SetEmitMessageFunction (HBaseViewEmitMessageFunction new_emit_message_function, void *user_data=0)

void SetEventCheckerCallback (void(*EventChecker)(struct ht_net_rendition *nr))

void SetFastFitWorld (bool fw)

virtual void SetFontSize (const char *font_size, bool emit_message=false)

virtual void SetFontSizeFromMessage (const char *in_data, unsigned int data_length)

void SetForceFastHiddenLine (bool force)

virtual void SetGeometryChanged ()

virtual void SetHandedness (HandednessMode mode, bool emit_message=false)

virtual void SetHandednessFromMessage (const char *in_data, unsigned int data_length)

virtual void SetHandleOperator (HBaseOperator *op)

virtual void SetHasObjects (bool hasobjects)

void SetHideOverlappedText (bool hide)

virtual void SetHighlightMode (HSelectionHighlightMode m)

void SetIncludeLinkKey (HC_KEY link)

virtual void SetInitialCamera (HPoint pos, HPoint tar, HPoint up, float fieldx, float fieldy, char *proj)

void SetIntersectPolylinesKey (HC_KEY intersectpolylines_key)

virtual void SetInvertMouseWheelZoom (bool val=true)

void SetIsoDefault (ViewMode vm)

void SetKeyStateCallback (bool(*KeyState)(unsigned int, int &))

void SetLightFollowsCamera (bool onoroff)

void SetLightsKey (HC_KEY lights_key)

void SetLineAntialiasing (bool onoff)

void SetLodMode (bool onoff)

void SetLodThreshold (int val)

void SetMarkupManager (HMarkupManager *markup)

void SetMaximumUpdateTime (float mut)

virtual void SetModellingMatrixFromMessage (const char *in_data, unsigned int data_length)

void SetNavCube (bool onoff)

void SetOcclusionCullingMode (bool mode, bool UseOctree=true, int threshold=50)

void SetOperator (HBaseOperator *NewOperator)

void SetPolygonHandednessMode (HandednessMode)

void SetProgressBarKey (HC_KEY key)

void SetProjMode (ProjMode mode)

void SetRecordCamera (bool rc)

virtual void SetReferenceSelection (bool use_ref)

virtual void SetRelatedSelectionLimit (int limit)

virtual void SetRenderMode (HRenderMode NewRenderMode, bool emit_message=false)

virtual void SetRenderModeFromMessage (const char *in_data, unsigned int data_length)

void SetSceneBounding (HPoint &min, HPoint &max)

void SetSceneKey (HC_KEY scene_key)

void SetSelection (HSelectionSet *selection)

virtual void SetShadowBlurring (int blur)

virtual void SetShadowColor (HPoint color)

virtual void SetShadowMode (HShadowMode sm, bool saveMode=true)

virtual void SetShadowRegenerationMode (bool onoff)

virtual void SetShadowRegenerationToggle ()

void SetShadowRenderingMode (HShadowRenderingMode mode)

virtual void SetShadowResolution (int res)

unsigned long SetSignalNotify (int signal, HSignalNotifyFunction callback, void *user_data)

void SetSmoothTransition (bool onoff)

void SetSmoothTransitionDuration (float duration)

void SetSpritingMode (bool onoff)

bool SetStencilProbe (HStencilProbe *sp)

void SetSuppressUpdate (bool suppress)

void SetTextAntialiasing (bool onoff)

void SetTransparency (char *text, bool fast_z_sort=false)

void SetTransparentSelectionBoxMode (bool mode)

void SetUpdateInterrupted (int val)

int SetupHandlesEvent (HBaseView *view, HC_KEY key, bool complex)

void SetViewAxis (HVector *front_axis, HVector *top_axis)

void SetViewKey (HC_KEY view_key)

virtual void SetViewMode (ViewMode mode, bool invert=false, bool fitWorld=true)

void SetViewSelectionLevel (HViewSelectionLevel level)

void SetViewUpdateMode (ViewUpdateMode mode, float rate=0.01f)

virtual void SetVisibilitySelectionMode (bool onoff)

virtual void SetWindowColor (HPoint rgbtop, HPoint rgbbottom, bool emit_message=false)

virtual void SetWindowColor (HPoint rgb, bool emit_message=false)

virtual void SetWindowColorFromMessage (const char *in_data, unsigned int data_length)

virtual void SetWindowColorRange (HPoint rgbtop, HPoint rgbbottom, int percentage, bool emit_message=false)

virtual void SetWindowMaterial (const char *name, bool emit_message=false)

void SetWindowspaceKey (HC_KEY winspace_key)

void SetZoomLimit ()

void SetZoomLimit (float zoomLimit)

virtual void SmartFilterCircumcuboid (const char *segment, const char *defaults, HPoint *bottomfrontleft, HPoint *topbackright)

virtual void StartSharedKey ()

void UnSetSignalNotify (unsigned long cookie)

virtual void Update ()

void UpdateAxisTriad ()

int UpdateEvent (bool antialias=false, bool forceUpdate=false)

virtual void ZoomToExtents ()

virtual void ZoomToInitialCamera ()

virtual ~HBaseView ()

Static Public Member Functions

static void AdjustAxisWindowCallback (int signal, void *signal_data, void *user_data)

static bool StreamProgressCallback (unsigned long so_far, unsigned long expected, void *user_data)

static bool UpdateTick (float request_time, float actual_time, void *user_data)

Protected Member Functions

void AdjustShadowPlane (HPlane &shadow_plane, HPoint const &light_pos)

void ComputeShadowParams (HPlane &shadow_plane, HPoint &light_pos)

void QueryDeviceCapabilities ()

virtual void SetShadowParams (HShadow *shadowObj)

void SetShadowParams (const HPlane &shadow_plane, const HPoint &light_pos, const HPoint *color=0, const char *filter=0)

void StencilUpdate ()

virtual void UpdateInternal (bool antialias=false, bool doUpdate=false)

bool UseStencilProbe ()

Protected Attributes

unsigned long m_AnnotationCookie

unsigned long m_AxisResizeCookie

HC_KEY m_AxisTriadKey

int m_AxisWindowSize

bool m_bAllowInteractiveCutGeometry

bool m_bAllowInteractiveShadows

AxisMode m_bAxisMode

bool m_bAxisTriadTransparencyAllowed

bool m_bBeginShellSelection

HC_KEY m_BBoxGeometryKey

bool m_bCameraChanged

bool m_bCPFaceVisibility

bool m_bCPLineVisibility

bool m_bCuttingPlaneRegeneration

bool m_bCuttingPlanesExist

bool m_bCuttingPlanesVisibility

bool m_bDisplayHandlesOnDblClk

bool m_bFastFitWorld

bool m_bFirstUpdate

bool m_bForceFastHiddenLine

bool m_bGeometryChanged

bool m_bHideOverlappedText

bool m_bInitialCameraSet

bool m_bInvertMouseWheelZoom

bool m_bLButtonDown

bool m_bLightFollowsCamera

bool m_bLineAntialiasing

bool m_bMouseMove

bool m_bNavCube

bool m_bRecordCamera

bool m_bSceneBoundingSet

bool m_bShadowRegeneration

bool m_bShadowRegenerationToggle

bool m_bSmoothTransition

bool m_bSpritingAllowed

bool m_bTextAntialiasing

bool m_bTransparentSelectionBox

bool m_bUpdateRequested

HC_KEY m_ConstructionKey

int m_CPMode

HC_KEY m_CuttingPlaneGeomKey

HC_KEY m_CuttingPlanesKey

float m_DefaultSelectionProximity

DisplayListType m_DisplayListType

HVector m_FrontAxis

bool m_has_initial_view

HSelectionHighlightMode m_HighlightMode

float m_IdleTime

HC_KEY m_InfoTextKey

HCamera m_InitialCamera

HC_KEY m_IntersectPolylinesKey

ViewMode m_IsoDefault

HC_KEY m_LightsKey

HC_KEY m_lIncludeLinkKey

float m_MaximumUpdateTime

HC_KEY m_OverwriteKey

HUtilityAntialiasing * m_pAntialiasing

HConstantFrameRate * m_pConstantFrameRate

class HDebugZBuffer * m_pDebugZBuffer

HEventInfo * m_pEvent

HEventManager * m_pEventManager

void(* m_pfEventChecker )(struct ht_net_rendition *nr)

bool(* m_pfKeyState )(unsigned int, int &)

HBaseOperator * m_pHandleOperator

HSelectionSet * m_pHighlight

HImCuttingGeometry * m_pHImCuttingGeometry

HOpCameraManipulate * m_pManipulateOperator

HMarkupManager * m_pMarkupManager

HBaseModel * m_pModel

HObjectManager * m_pObjectManager

HBaseOperator * m_pOperator

HC_KEY m_ProgressBarKey

HSelectionSet * m_pSelection

HSharedKey * m_pSharedKey

class HStencilProbe * m_pStencilProbe

HUndoManager * m_pUndoManager

HRenderMode m_RenderMode

HPoint m_SceneBoundingMax

HPoint m_SceneBoundingMin

HC_KEY m_SceneKey

HC_KEY m_SceneLight

HShadowMode m_ShadowMode

float m_SmoothTransitionDuration

HVector m_TopAxis

int m_UpdateInterrupted

HC_KEY m_ViewKey

ViewMode m_ViewMode

ViewUpdateMode m_ViewUpdateMode

HPoint m_WindowColor

HPoint m_WindowColorBottom

int m_WindowColorPercentage

HC_KEY m_WindowspaceKey

Friends

class HStencilProbe

Detailed Description

The HBaseView class defines and manages a view of model information.

The HBaseView class stores view-specific information and provides a high level interface for managing viewing attributes. A view typically references an HBaseModel object to define a view of a model.

This class encapsulates a HOOPS segment associated with a an instance of a HOOPS driver. This type of segment defines a connection to a device. (i.e. OpenGL, X11, GDI, etc...) It's Init method creates a default segment structure under the driver instance segment, which is used to manage the inclusion of the HOOPS Include Library segment associated with HBaseModel, lights for the scene, and segments containing camera and window attributes used for temporary 'rubberband' graphics.

The HBaseView object has associations with the following objects:

HBaseModel HEventInfo HSelectionSet HBaseOperator

It also implements the following viewing manipulations by setting the appropriate HOOPS camera attributes:

Fit the view's camera to the model's extents, Fit the view's camera to the extents of the current selection set Fit the view's camera to the extents of the entire world. Set the view to default angles (XY, YZ, XZ target planes)

It includes interfaces for managing:

Rendering methods (antialiasing, shadows, capping lines/faces, etc...) Hidden Surface Removal Algorithms Lighting Interpolation Camera Projection Constant Framerate Logic

Member Enumeration Documentation

enum HBaseView::HAnimateMode

Indicates how the scene should be animated; obselete; animation should be performed using MVO's behavior/animation support.

Constructor & Destructor Documentation

HBaseView::HBaseView	(	HBaseModel *	model,
		const char *	alias = `0`,
		const char *	driver_type = `0`,
		const char *	instance_name = `0`,
		void *	window_handle = `0`,
		void *	colormap = `0`,
		void *	clip_override = `0`,
		void *	window_handle_2 = `0`,
		const char *	driver_path = `0`
	)

Constructs an HBaseView object.

Parameters:

	model	A pointer to the HBaseModel object, which defines the model to viewed by this HBaseView object. If model is null, then the view will not reference any external part of the HOOPS segment tree, and can only view geometry that is created directly underneath the HBaseView object's 'scene' segment
	alias	A character pointer denoting the HOOPS alias representing the driver instance segment encapsulated by this HBaseView object
	driver_type	A character pointer denoting the type of HOOPS driver instance that should be created to correspond with this HBaseView object
	instance_name	A character pointer denoting the name of the HOOPS driver instance associated with this HBaseView object. For example, this might be 'window' if driver_type is 'msw', or 'unix:0.0' if driver_type is 'x11' If either driver_type or instance_name are null, HOOPS will use default values obtained from the unique hDB HOOPS MVO object.
	window_handle	This identifies the handle of the precreated native window system window (X11 or GDI) which the HOOPS driver instance segment should draw into. HOOPS will not handle any events for this window if it is passed in. If window_handle is null, HOOPS will automatically create a native window, and manage it's updating as well as all events.
	colormap	This identifies a native window system colormap which HOOPS will utilize when allocating and managing colors. If null, HOOPS will creates it's own system colormap as necessary.
	clip_override	This identifies a pointer to a clip override array.
	window_handle_2	This identifies a window handle to be used for use window id2.
	driver	path If provided this driver path will be used rather than an internally generated one.

virtual HBaseView::~HBaseView ( ) [virtual]

Deletes the HOOPS segment tree and operator/event/selection/framerate-support objects associated with this view

Member Function Documentation

virtual void HBaseView::AdjustAxisWindow	(	int	axis_window_pixels_in = `-1`,
		HIntRectangle *	rect_in = `0`
	)			`[virtual]`

This method adjusts the size of the axis triad to keep it as a constant size.

Parameters:

	axis_window_pixels_in	The width and height of the axis triad, given as a number of pixels. The value is defaulted to negative -1 which leaves the size unchanged but adjusts it to keep it constant in screen space.
	rect_in	The screen space rectangle of the drawing context. This parameter is optional.

void HBaseView::AdjustShadowPlane	(	HPlane &	shadow_plane,
		HPoint const &	light_pos
	)			`[protected]`

This method adjusts the shadow plane so that it is consistent with the current plane orientation. It also positions it so that it remains outside the bounding box of the model.

Parameters:

	shadow_plane	Returns the HPlane (a,b,c,d) value for the plane computed.
	light_pos	Returns the HPoint (x,y,z) value representing light position for shadow.

virtual void HBaseView::Animate ( int animation_steps = 30,


Public Types
enum	HAnimateMode { HAnimateScene = 0x00000001 }
Public Member Functions
virtual void	AdjustAxisWindow (int axis_window_pixels_in=-1, HIntRectangle *rect_in=0)
virtual void	Animate (int animation_steps=30, HAnimateMode animate_flags=HAnimateScene, int MaxRotation=360)
void	BeginShellSelection ()
virtual void	CameraPositionChanged (bool emit_message=false, bool smooth_camera_transition=false)
void	cleanupSimpList ()
virtual void	ClearGeometryChanged ()
void	ClearUpdateRequest ()
virtual void	DeleteByKeyFromMessage (const char *in_data, unsigned int data_length)
virtual void	DeleteSelectionList (bool emit_message=false)
virtual void	DeleteSelectionListFromMessage ()
virtual void	DeSelectAllFromMessage ()
virtual void	DoDynamicHighlighting (HPoint mouse_pos)
virtual void	EmitDeleteByKeyMessage (HC_KEY key)
virtual void	EmitDeleteSelectionListMessage ()
virtual void	EmitDeSelectAllMessage ()
virtual void	EmitFlushMessage ()
virtual void	EmitHSFData (const char segment, const char in_data, unsigned int data_length)
virtual void	EmitSegment (HC_KEY key, bool emit_contents_only=false)
virtual void	EmitSelectMessage (HC_KEY key, bool isSelect)
virtual void	EmitSetModellingMatrixMessage ()
virtual void	EmitSetModellingMatrixMessage (HC_KEY key)
bool	EmittingMessages ()
void	EnableTargetFrameRate (bool enable=true, int target=100, int threshold=10, int steps=5)
void	EndShellSelection ()
virtual HFileInputResult	FileInput (const unsigned short FileName, HInputHandler handler, HInputHandlerOptions *options=0)
virtual HFileInputResult	FileInput (const char FileName, HInputHandler handler, HInputHandlerOptions *options=0)
virtual HFileOutputResult	FileOutput (const char FileName, HOutputHandler handler, HOutputHandlerOptions *options=0)
void	FitSegment (HC_KEY seg_key)
void	FitSelection (HC_KEY key=INVALID_KEY)
virtual void	FitWorld (HPoint *center_out=0)
virtual void	FitWorldExact (HPoint *center_out=0)
virtual void	Flush (bool emit_message=false)
virtual void	FlushFromMessage (const char *in_data, unsigned int data_length)
void	FlushProgressBar ()
virtual void	ForceUpdate ()
virtual bool	GeometryChanged ()
bool	GetAllowInteractiveCutGeometry ()
bool	GetAllowInteractiveShadows ()
bool	GetAnnotationResize ()
HUtilityAntialiasing *	GetAntialiasing ()
AxisMode	GetAxisMode ()
HC_KEY	GetAxisTriadKey ()
bool	GetBackplaneCulling ()
HC_KEY	GetBBoxGeometryKey (void)
virtual void	GetCamera (HCamera *camera)
virtual void	GetCamera (HPoint pos, HPoint tar, HPoint up, float &fieldx, float &fieldy, char proj)
virtual bool	GetCameraChanged ()
bool	GetColorIndexInterpolation (char *option=0)
HConstantFrameRate *	GetConstantFrameRateObject (void)
HC_KEY	GetConstructionKey (void)
bool	GetCPFaceVisibility ()
bool	GetCPLineVisibility ()
int	GetCullingThreshold ()
HBaseOperator *	GetCurrentOperator ()
HCutGeometryVisibility	GetCutGeometryVisibility ()
HC_KEY	GetCuttingPlaneGeomKey (void)
bool	GetCuttingPlaneRegenerationMode ()
bool	GetCuttingPlanesExist (const char *plane=0)
HC_KEY	GetCuttingPlanesKey (void)
bool	GetCuttingPlanesVisibility ()
class HDebugZBuffer *	GetDebugZBuffer ()
HC_KEY	GetDefaultLightKey (void)
virtual float	GetDefaultSelectionProximity ()
virtual bool	GetDetailSelectionMode ()
bool	GetDisplayListMode ()
DisplayListType	GetDisplayListType ()
const char *	GetDriverPath (void)
const char *	GetDriverType (void)
bool	GetDynamicHighlighting ()
HBaseViewEmitMessageFunction	GetEmitMessageFunction ()
void *	GetEmitMessageFunctionUserData ()
void(*	GetEventCheckerCallback ())(struct ht_net_rendition *nr)
HEventManager *	GetEventManager ()
bool	GetFirstUpdate ()
bool	GetForceFastHiddenLine ()
HandednessMode	GetHandedness ()
virtual HBaseOperator *	GetHandleOperator ()
virtual bool	GetHasObjects ()
bool	GetHideOverlappedText ()
virtual const HSelectionHighlightMode	GetHighlightMode ()
HSelectionSet *	GetHighlightSelection ()
HObjectManager *	GetHObjectManager ()
float	GetIdleTime (void)
HC_KEY	GetIncludeLinkKey (void)
bool	GetInitialCameraSet ()
HC_KEY	GetIntersectPolylinesKey (void)
virtual bool	GetInvertMouseWheelZoom ()
ViewMode	GetIsoDefault ()
bool	GetKeyState (unsigned int key, int &flags)
bool(*	GetKeyStateCallback ())(unsigned int, int &)
HC_KEY	GetLightsKey (void)
bool	GetLineAntialiasing ()
bool	GetLodMode ()
int	GetLodThreshold ()
HMarkupManager *	GetMarkupManager ()
float	GetMaximumUpdateTime ()
HBaseModel *	GetModel ()
HC_KEY	GetModelKey ()
HBaseOperator *	GetOperator ()
HC_KEY	GetOverwriteKey (void)
HandednessMode	GetPolygonHandednessMode ()
HC_KEY	GetProgressBarKey (void)
ProjMode	GetProjMode ()
HQuickMovesMethod	GetQuickMovesMethod () const
bool	GetRecordMode ()
virtual int	GetRelatedSelectionLimit ()
HRenderMode	GetRenderMode ()
bool	GetSceneBoundingSet ()
void	GetSceneExtents (HPoint &min, HPoint &max)
HC_KEY	GetSceneKey (void)
HSelectionSet *	GetSelection (void)
HShadowMode	GetShadowMode ()
bool	GetShadowRegenerationMode ()
HShadowRenderingMode	GetShadowRenderingMode ()
HSharedKey *	GetSharedKey ()
bool	GetSmoothTransition ()
float	GetSmoothTransitionDuration ()
bool	GetSpritingMode ()
class HStencilProbe *	GetStencilProbe ()
bool	GetSuppressUpdate ()
bool	GetTextAntialiasing ()
bool	GetTransparentSelectionBoxMode ()
HUndoManager *	GetUndoManager ()
int	GetUpdateInterrupted ()
bool	GetUpdateRequested ()
void	GetViewAxis (HVector front_axis, HVector top_axis)
HC_KEY	GetViewKey (void)
ViewMode	GetViewMode ()
HViewSelectionLevel	GetViewSelectionLevel ()
ViewUpdateMode	GetViewUpdateMode ()
virtual bool	GetVisibilitySelectionMode ()
void	GetWindowColor (HPoint &color_top, HPoint &color_bottom, int &percentage)
void	GetWindowColor (HPoint &color_top, HPoint &color_bottom)
void	GetWindowColor (HPoint &color_out)
void *	GetWindowHandle ()
HC_KEY	GetWindowspaceKey (void)
int	GetXSize ()
int	GetYSize ()
float	GetZoomLimit (void)
void	HasInitialView (bool does_it)
bool	HasInitialView ()
	HBaseView (HBaseModel model, const char alias=0, const char driver_type=0, const char instance_name=0, void window_handle=0, void colormap=0, void clip_override=0, void window_handle_2=0, const char *driver_path=0)
virtual void	Init ()
void	InitAntialiasing ()
void	InjectEvent (HEventInfo hevent)
virtual void	InsertHSFData (const char segment, const char in_data, unsigned int data_length, bool emit_message=false)
virtual void	InsertHSFDataFromMessage (const char *in_data, unsigned int data_length)
virtual void	InternalUpdate ()
void	InvalidateSceneBounding ()
bool	IsFrameRateEnabled ()
bool	IsLightFollowCamera ()
void	Notify (int signal, void *signal_data=0)
int	ObjectMovedEvent (HBaseView view, HC_KEY key, HPoint pos)
virtual int	OnKeyDown (HEventInfo &hevent)
virtual int	OnKeyUp (HEventInfo &hevent)
virtual int	OnLButtonDblClk (HEventInfo &hevent)
virtual int	OnLButtonDown (HEventInfo &hevent)
virtual int	OnLButtonDownAndMove (HEventInfo &hevent)
virtual int	OnLButtonUp (HEventInfo &hevent)
virtual int	OnLRButtonDownAndMove (HEventInfo &hevent)
virtual int	OnMButtonDownAndMove (HEventInfo &hevent)
virtual int	OnMouseMove (HEventInfo &hevent)
virtual int	OnMouseWheel (HEventInfo &hevent)
virtual int	OnNoButtonDownAndMove (HEventInfo &hevent)
virtual int	OnRButtonDownAndMove (HEventInfo &hevent)
virtual void	PrepareForCameraChange ()
void	RebindView (const char alias=0, const char driver_type=0, const char instance_name=0, void window_handle=0, void colormap=0, void clip_override=0, void *window_handle_2=0, int debug_flags=0)
void	RemoveTransforms ()
void	RenderAntialiasing ()
void	RenderBRepHiddenLine ()
void	RenderBRepHiddenLineFast ()
void	RenderBRepWireframe ()
void	RenderFlat ()
void	RenderGouraud ()
void	RenderGouraudWithLines ()
void	RenderHiddenLine ()
void	RenderHiddenLineFast ()
void	RenderLOD1 ()
void	RenderLOD2 ()
void	RenderPhong ()
void	RenderShaded ()
void	RenderShadedVertices ()
void	RenderShadedWireframe ()
void	RenderShadedWithLines ()
void	RenderSilhouette ()
void	RenderVertices ()
void	RenderWireframe ()
void	RenderWireframeWithSilhouette ()
void	RequestUpdate ()
void	ResetIdleTime (void)
void	ResetKeyState ()
void	RotateOnUpdate (const char *sname)
virtual void	SelectFromMessage (const char *in_data, unsigned int data_length)
void	SetAllowInteractiveCutGeometry (bool onoff)
void	SetAllowInteractiveShadows (bool onoff)
void	SetAnnotationResize (bool value)
virtual void	SetAxisManipulateOperator (HOpCameraManipulate *op)
void	SetAxisMode (AxisMode mode)
void	SetBackplaneCulling (bool cull)
void	SetBBoxGeometryKey (HC_KEY bbox_key)
virtual void	SetCamera (HCamera camera)
virtual void	SetCamera (HPoint pos, HPoint tar, HPoint up, float fieldx, float fieldy, char *proj)
virtual void	SetCameraChanged (bool val=true)
virtual void	SetCameraFromMessage (const char *data, unsigned int data_length)
void	SetColorIndexInterpolation (bool onoff, bool isolines=false)
void	SetColorInterpolation (bool onoff)
void	SetConstantFrameRateObject (HConstantFrameRate *cf)
void	SetConstructionKey (HC_KEY construct_key)
void	SetCPGeomVisibility (bool lines, bool faces=false)
void	SetCullingThreshold (int cullingthreshold)
void	SetCurrentOperator (HBaseOperator *NewOperator)
void	SetCutGeometryVisibility (HCutGeometryVisibility visibility)
void	SetCuttingPlaneGeomKey (HC_KEY cuttingplanegeom_key)
virtual void	SetCuttingPlaneRegenerationMode (bool onoff)
void	SetCuttingPlanesExist (bool state)
void	SetCuttingPlanesKey (HC_KEY cuttingplanes_key)
void	SetCuttingPlanesVisibility (bool visible)
void	SetDebugZBuffer (HDebugZBuffer *dzb)
void	SetDefaultHSRA ()
virtual void	SetDefaultSelectionProximity (float selectionproximity)
virtual void	SetDetailSelection (bool onoff)
void	SetDisplayHandlesOnDblClk (bool dh)
void	SetDisplayListMode (bool mode)
void	SetDisplayListType (DisplayListType type)
void	SetDynamicHighlighting (bool state)
void	SetEmitMessageFunction (HBaseViewEmitMessageFunction new_emit_message_function, void *user_data=0)
void	SetEventCheckerCallback (void(EventChecker)(struct ht_net_rendition nr))
void	SetFastFitWorld (bool fw)
virtual void	SetFontSize (const char *font_size, bool emit_message=false)
virtual void	SetFontSizeFromMessage (const char *in_data, unsigned int data_length)
void	SetForceFastHiddenLine (bool force)
virtual void	SetGeometryChanged ()
virtual void	SetHandedness (HandednessMode mode, bool emit_message=false)
virtual void	SetHandednessFromMessage (const char *in_data, unsigned int data_length)
virtual void	SetHandleOperator (HBaseOperator *op)
virtual void	SetHasObjects (bool hasobjects)
void	SetHideOverlappedText (bool hide)
virtual void	SetHighlightMode (HSelectionHighlightMode m)
void	SetIncludeLinkKey (HC_KEY link)
virtual void	SetInitialCamera (HPoint pos, HPoint tar, HPoint up, float fieldx, float fieldy, char *proj)
void	SetIntersectPolylinesKey (HC_KEY intersectpolylines_key)
virtual void	SetInvertMouseWheelZoom (bool val=true)
void	SetIsoDefault (ViewMode vm)
void	SetKeyStateCallback (bool(*KeyState)(unsigned int, int &))
void	SetLightFollowsCamera (bool onoroff)
void	SetLightsKey (HC_KEY lights_key)
void	SetLineAntialiasing (bool onoff)
void	SetLodMode (bool onoff)
void	SetLodThreshold (int val)
void	SetMarkupManager (HMarkupManager *markup)
void	SetMaximumUpdateTime (float mut)
virtual void	SetModellingMatrixFromMessage (const char *in_data, unsigned int data_length)
void	SetNavCube (bool onoff)
void	SetOcclusionCullingMode (bool mode, bool UseOctree=true, int threshold=50)
void	SetOperator (HBaseOperator *NewOperator)
void	SetPolygonHandednessMode (HandednessMode)
void	SetProgressBarKey (HC_KEY key)
void	SetProjMode (ProjMode mode)
void	SetRecordCamera (bool rc)
virtual void	SetReferenceSelection (bool use_ref)
virtual void	SetRelatedSelectionLimit (int limit)
virtual void	SetRenderMode (HRenderMode NewRenderMode, bool emit_message=false)
virtual void	SetRenderModeFromMessage (const char *in_data, unsigned int data_length)
void	SetSceneBounding (HPoint &min, HPoint &max)
void	SetSceneKey (HC_KEY scene_key)
void	SetSelection (HSelectionSet *selection)
virtual void	SetShadowBlurring (int blur)
virtual void	SetShadowColor (HPoint color)
virtual void	SetShadowMode (HShadowMode sm, bool saveMode=true)
virtual void	SetShadowRegenerationMode (bool onoff)
virtual void	SetShadowRegenerationToggle ()
void	SetShadowRenderingMode (HShadowRenderingMode mode)
virtual void	SetShadowResolution (int res)
unsigned long	SetSignalNotify (int signal, HSignalNotifyFunction callback, void *user_data)
void	SetSmoothTransition (bool onoff)
void	SetSmoothTransitionDuration (float duration)
void	SetSpritingMode (bool onoff)
bool	SetStencilProbe (HStencilProbe *sp)
void	SetSuppressUpdate (bool suppress)
void	SetTextAntialiasing (bool onoff)
void	SetTransparency (char *text, bool fast_z_sort=false)
void	SetTransparentSelectionBoxMode (bool mode)
void	SetUpdateInterrupted (int val)
int	SetupHandlesEvent (HBaseView *view, HC_KEY key, bool complex)
void	SetViewAxis (HVector front_axis, HVector top_axis)
void	SetViewKey (HC_KEY view_key)
virtual void	SetViewMode (ViewMode mode, bool invert=false, bool fitWorld=true)
void	SetViewSelectionLevel (HViewSelectionLevel level)
void	SetViewUpdateMode (ViewUpdateMode mode, float rate=0.01f)
virtual void	SetVisibilitySelectionMode (bool onoff)
virtual void	SetWindowColor (HPoint rgbtop, HPoint rgbbottom, bool emit_message=false)
virtual void	SetWindowColor (HPoint rgb, bool emit_message=false)
virtual void	SetWindowColorFromMessage (const char *in_data, unsigned int data_length)
virtual void	SetWindowColorRange (HPoint rgbtop, HPoint rgbbottom, int percentage, bool emit_message=false)
virtual void	SetWindowMaterial (const char *name, bool emit_message=false)
void	SetWindowspaceKey (HC_KEY winspace_key)
void	SetZoomLimit ()
void	SetZoomLimit (float zoomLimit)
virtual void	SmartFilterCircumcuboid (const char segment, const char defaults, HPoint bottomfrontleft, HPoint topbackright)
virtual void	StartSharedKey ()
void	UnSetSignalNotify (unsigned long cookie)
virtual void	Update ()
void	UpdateAxisTriad ()
int	UpdateEvent (bool antialias=false, bool forceUpdate=false)
virtual void	ZoomToExtents ()
virtual void	ZoomToInitialCamera ()
virtual	~HBaseView ()
Static Public Member Functions
static void	AdjustAxisWindowCallback (int signal, void signal_data, void user_data)
static bool	StreamProgressCallback (unsigned long so_far, unsigned long expected, void *user_data)
static bool	UpdateTick (float request_time, float actual_time, void *user_data)
Protected Member Functions
void	AdjustShadowPlane (HPlane &shadow_plane, HPoint const &light_pos)
void	ComputeShadowParams (HPlane &shadow_plane, HPoint &light_pos)
void	QueryDeviceCapabilities ()
virtual void	SetShadowParams (HShadow *shadowObj)
void	SetShadowParams (const HPlane &shadow_plane, const HPoint &light_pos, const HPoint color=0, const char filter=0)
void	StencilUpdate ()
virtual void	UpdateInternal (bool antialias=false, bool doUpdate=false)
bool	UseStencilProbe ()
Protected Attributes
unsigned long	m_AnnotationCookie
unsigned long	m_AxisResizeCookie
HC_KEY	m_AxisTriadKey
int	m_AxisWindowSize
bool	m_bAllowInteractiveCutGeometry
bool	m_bAllowInteractiveShadows
AxisMode	m_bAxisMode
bool	m_bAxisTriadTransparencyAllowed
bool	m_bBeginShellSelection
HC_KEY	m_BBoxGeometryKey
bool	m_bCameraChanged
bool	m_bCPFaceVisibility
bool	m_bCPLineVisibility
bool	m_bCuttingPlaneRegeneration
bool	m_bCuttingPlanesExist
bool	m_bCuttingPlanesVisibility
bool	m_bDisplayHandlesOnDblClk
bool	m_bFastFitWorld
bool	m_bFirstUpdate
bool	m_bForceFastHiddenLine
bool	m_bGeometryChanged
bool	m_bHideOverlappedText
bool	m_bInitialCameraSet
bool	m_bInvertMouseWheelZoom
bool	m_bLButtonDown
bool	m_bLightFollowsCamera
bool	m_bLineAntialiasing
bool	m_bMouseMove
bool	m_bNavCube
bool	m_bRecordCamera
bool	m_bSceneBoundingSet
bool	m_bShadowRegeneration
bool	m_bShadowRegenerationToggle
bool	m_bSmoothTransition
bool	m_bSpritingAllowed
bool	m_bTextAntialiasing
bool	m_bTransparentSelectionBox
bool	m_bUpdateRequested
HC_KEY	m_ConstructionKey
int	m_CPMode
HC_KEY	m_CuttingPlaneGeomKey
HC_KEY	m_CuttingPlanesKey
float	m_DefaultSelectionProximity
DisplayListType	m_DisplayListType
HVector	m_FrontAxis
bool	m_has_initial_view
HSelectionHighlightMode	m_HighlightMode
float	m_IdleTime
HC_KEY	m_InfoTextKey
HCamera	m_InitialCamera
HC_KEY	m_IntersectPolylinesKey
ViewMode	m_IsoDefault
HC_KEY	m_LightsKey
HC_KEY	m_lIncludeLinkKey
float	m_MaximumUpdateTime
HC_KEY	m_OverwriteKey
HUtilityAntialiasing *	m_pAntialiasing
HConstantFrameRate *	m_pConstantFrameRate
class HDebugZBuffer *	m_pDebugZBuffer
HEventInfo *	m_pEvent
HEventManager *	m_pEventManager
void(*	m_pfEventChecker )(struct ht_net_rendition *nr)
bool(*	m_pfKeyState )(unsigned int, int &)
HBaseOperator *	m_pHandleOperator
HSelectionSet *	m_pHighlight
HImCuttingGeometry *	m_pHImCuttingGeometry
HOpCameraManipulate *	m_pManipulateOperator
HMarkupManager *	m_pMarkupManager
HBaseModel *	m_pModel
HObjectManager *	m_pObjectManager
HBaseOperator *	m_pOperator
HC_KEY	m_ProgressBarKey
HSelectionSet *	m_pSelection
HSharedKey *	m_pSharedKey
class HStencilProbe *	m_pStencilProbe
HUndoManager *	m_pUndoManager
HRenderMode	m_RenderMode
HPoint	m_SceneBoundingMax
HPoint	m_SceneBoundingMin
HC_KEY	m_SceneKey
HC_KEY	m_SceneLight
HShadowMode	m_ShadowMode
float	m_SmoothTransitionDuration
HVector	m_TopAxis
int	m_UpdateInterrupted
HC_KEY	m_ViewKey
ViewMode	m_ViewMode
ViewUpdateMode	m_ViewUpdateMode
HPoint	m_WindowColor
HPoint	m_WindowColorBottom
int	m_WindowColorPercentage
HC_KEY	m_WindowspaceKey
Friends
class	HStencilProbe