HSubwindow

class HSubwindow

The HSubwindow class encapsulates interactive floating subwindows.

Subwindows can be used for things like displaying legend bars to different views of a particular scene. They can live outside of a particular model or can be stored inside an HSF file while retaining their functionality. Similar to GUI windows, they can be dragged, resized and deleted.

Inherits from: HObject, HBaseOperator, HUpdateListener, HFitWorldListener, HObjectManipulationListener

Methods

HSubwindow::HSubwindow(HBaseView *view, int DoRepeat = 0, int DoCapture = 1)

Constructs an HSubwindow object.

Parameters

view: A pointer to an HBaseView object.

DoRepeat: An integer denoting whether this is a repeatable operator. This parameter has been deprecated.

DoCapture: An integer denoting whether the mouse state should be captured, which means that all mouse events should be received after a mousedown, even if it leaves the window. This parameter has been deprecated.

HSubwindow::HSubwindow()

Constructs an HSubwindow object.

virtual HSubwindow::~HSubwindow()

virtual

virtual void HSubwindow::Insert(float left, float right, float bottom, float top, int type = SUBWINDOW_NOTYPE, long appearance = SW_BORDER | SW_SIZE_FIELD | SW_MOVE_FIELD | SW_DRAG_FIELD | SW_DELETE_FIELD | SW_MAGNIFIER_FIELD | SW_BACKGROUND_BOX)

virtual

This method inserts a new HSubwindow object into the currently open segment.

Parameters

left: The minimum horizontal coordinate of the window.

right: The maxium horizontal coordinate of the window.

bottom: The maximum vertical coordinate of the window.

top: The minium vertical coordinate of the window.

type: The subwindow type which can be SUBWINDOW_NOTYPE, SUBWINDOW_MAGNIFIER, SUBWINDOW_SNAPSHOT or SUBWINDOW_POINTER.

appearance: Bitfields describing the window characteristics which can be any combination of the following: SW_BORDER , SW_SIZE_FIELD, SW_MOVE_FIELD, SW_DRAG_FIELD, SW_DELETE_FIELD, SW_MAGNIFIER_FIELD, SW_BACKGROUND_BOX.

virtual void HSubwindow::Reset()

virtual

This method resets the window parameters so the HSubwindow object is disassociated from the subwindow segment key in the HOOPS database.

virtual bool HSubwindow::IsActive()

virtual

Returns

True if the subwindow is represented by a segment in the HOOPS database or false if it isn’t.
virtual void HSubwindow::GetFromKey(HC_KEY key)

virtual

This method retrieves the window characteristics from the given segment key.

Parameters

key: The segment key to get the window characteristics from.
virtual bool HSubwindow::IsSubwindow(HC_KEY key)

virtual

This method determines if the given segment is a subwindow.

Parameters

key: The segment key to check if it is a subwindow.

Returns

True if the given segment is a subwindow segment.
virtual bool HSubwindow::FindSubwindow(HBaseView *view, HPoint pos, bool &pointerselected)

virtual

Given a 2D position, this method finds if the subwindow is in that position.

Parameters

view: A pointer to the HBaseView object.

pos: The 2d window position.

pointerselected: Returns true if window maginifier pointer is found.

Returns

True if the subwindow was found or false if it was not.
virtual HC_KEY HSubwindow::FindSubwindowFromSegment(HC_KEY key)

virtual

Given a segment key, this method looks under the key to find if a subwindow exists.

Parameters

key: The segment key to look under.

Returns

The key to the top level subwindow segment or INVALID_KEY if no subwindow segment was found.
virtual void HSubwindow::GetPosition(float &x, float &y)

virtual

This method gets the subwindow’s position.

Parameters

x: Returns the horizontal position in window space.

y: Returns the vertical position in window space.

virtual void HSubwindow::SetPosition(float x, float y)

virtual

The method sets the subwindow position.

Parameters

x: The horizontal position in window space.

y: The vertical position in window space.

virtual HC_KEY HSubwindow::GetWindowKey()

virtual

Returns

The top level subwindow key.
virtual void HSubwindow::GetSize(float &x, float &y)

virtual

This method gets the subwindow size.

Parameters

x: Returns the width of the subwindow in window space.

y: Returns the height of the subwindow in window space.

virtual void HSubwindow::SetSize(float deltax, float deltay)

virtual

This method sets the subwindow size.

Parameters

deltax: The width of the subwindow in window space.

deltay: The height of the subwindow in window space.

virtual void HSubwindow::MakeCameraSnapshot(HBaseView *view)

virtual

This method resets the subwindow camera to the current camera in the view.

Parameters

view: A pointer to the HBaseView object.
virtual void HSubwindow::ConvertFromSubwindowToView(HPoint &in_point, HPoint &out_point)

virtual

This method converts a 2D point in the subwindow to a 2D point in the view.

Parameters

in_point: The 2D window space coordinates of the subwindow to be converted.

out_point: Returns the 2D coordinates converted to window space for the view.

virtual void HSubwindow::ConvertFromViewToSubwindow(HPoint const &in_point, HPoint &out_point)

virtual

This method converts a 2D point in the View to a 2D point in the subwindow.

Parameters

in_point: The 2D coordinate in the View in window space.

out_point: Returns the 2D coordinated in windowspace for the subwindow.

virtual void HSubwindow::ChangeType(int type, long appearance = SW_BORDER | SW_SIZE_FIELD | SW_MOVE_FIELD | SW_DRAG_FIELD | SW_DELETE_FIELD | SW_MAGNIFIER_FIELD | SW_BACKGROUND_BOX)

virtual

This method updates the subwindow type and appearance.

Parameters

type: The Subwindow Type which can be SUBWINDOW_NOTYPE, SUBWINDOW_MAGNIFIER, SUBWINDOW_SNAPSHOT or SUBWINDOW_POINTER.

appearance: Bitfields describing the window characteristics which can be any combination of the following: SW_BORDER, SW_SIZE_FIELD, SW_MOVE_FIELD, SW_DRAG_FIELD, SW_DELETE_FIELD, SW_MAGNIFIER_FIELD, SW_BACKGROUND_BOX.

virtual void HSubwindow::GetPointerPosition(float &x, float &y)

virtual

This method gets the position of the subwindow pointer.

Parameters

x: Returns the horizontal position in window space.

y: Returns the vertical position in window space.

virtual void HSubwindow::SetPointerPosition(float x, float y)

virtual

This method set the position of subwindow pointer.

Parameters

x: The horizontal position in window space.

y: The vertical position in window space.

virtual void HSubwindow::SetSize(float left, float right, float bottom, float top)

virtual

This method set the size of the subwindow.

Parameters

left: The left horizontal position.

right: The right horizontal position.

bottom: The bottom vertical position.

top: The top vertical position.

virtual void HSubwindow::ComputeCoordinates(HBaseView *view, char const *in_system, HPoint &from, char const *out_system, HPoint &to)

virtual

This method converts the given coordinate into the the out_system while still taking into account the transformation and rotation matrices along the subwindow segment path.

Parameters

view: A pointer to the HBaseView object.

in_system: The from coordinate space as described in #HC_Compute_Coordinates.

from: The coordinates to be converted.

out_system: The coordinate space that from will be converted into as described in #HC_Compute_Coordinates.

to: Returns the newly converted coordinate.

virtual void HSubwindow::Drag(HBaseView *view, HPoint p1, HPoint p2)

virtual

This method drags the subwindow from point p1 to point p2.

Parameters

view: A pointer to the HBaseView object.

p1: The point to drag from.

p2: The point to drag to.

virtual void HSubwindow::SyncViewToWindow(HBaseView *view)

virtual

This method synchronizes the view camera to the subwindow camera.

Parameters

view: A pointer to the HBaseView object.
virtual int HSubwindow::GetType()

virtual

This method retrieves the subwindow type.

Returns

virtual HC_KEY HSubwindow::GetKey()

virtual

This method retrieves the subwindow key.

Returns

The subwindow key.
virtual char const *HSubwindow::GetName()

virtual

Returns

The name of the object which is ‘subwindow’.
virtual int HSubwindow::OnLButtonDown(HEventInfo &hevent)

virtual

This method handles the left button down event by determining what type of action the user is trying to take depending on the position of the mouse pointer and the characteristics of the subwindow.

Parameters

hevent: An HEventInfo object containing the information about the current event.

Returns

An HOperatorReturn indicating the status of the event.
virtual int HSubwindow::OnLButtonUp(HEventInfo &hevent)

virtual

This method handles the left button up event. If the action is SW_ACTION_MOVE or SW_ACTION_MAGNIFYING, this method creates a new movement keyframe. If the action is SW_ACTION_SIZING, this method creates a new scale keyframe.

Parameters

hevent: An HEventInfo object containing the information about the current event.

Returns

An HOperatorReturn indicating the status of the event.
virtual int HSubwindow::CameraChangedEvent(HBaseView *view)

virtual

This method handles the event that is generated when the camera position changes by updating the scene according to the new camera position.

Parameters

view: A pointer to the HBaseView object.

Returns

An HOperatorReturn indicating the status of the event.
virtual int HSubwindow::PreFitWorldEvent(HBaseView *view)

virtual

This method handles the event generated before a call to FitWorld by setting the subwindow’s visiblity to off and locking the visibility attribute.

Parameters

view: A pointer to the HBaseView object.

Returns

An HOperatorReturn indicating the status of the event.
virtual int HSubwindow::PostFitWorldEvent(HBaseView *view)

virtual

This handles the event generate by a call to FitWorld by unsetting the subwindow’s visibility which was set to off during the PreFitWorldEvent and the associated attribute lock.

Parameters

view: A pointer to the HBaseView object.

Returns

An HOperatorReturn indicating the status of the event.
virtual int HSubwindow::OnLButtonDownAndMove(HEventInfo &hevent)

virtual

This method handles the left button down and move event by updating the window characteristics depending on the current action identified in the OnLButtonDown event. For instance, if the action was determined to be SW_ACTION_MOVE, then this event would cause the subwindow to move to the new position indicated in hevent. If the action was SW_ACTION_SIZING, then the subwindow would be resized.

Parameters

hevent: An HEventInfo object containing the information about the current event.

Returns

An HOperatorReturn indicating the status of the event.
virtual int HSubwindow::SetupHandlesEvent(HBaseView *view, HC_KEY key, bool complex)

virtual

This method handles set up handles event. Note that this implementation does not create handles for the subwindow.

Parameters

view: A pointer to the HBaseView object.

key: The key of the current object.

complex: Pass true to create complex handles.

Returns

An HOperatorReturn indicating the status of the event.
virtual int HSubwindow::ObjectMovedEvent(HBaseView *view, HC_KEY key, HPoint *p)

virtual

This method handles the object moved event by updating the subwindow position to the new object position p.

Parameters

view: A pointer to the HBaseView object.

key: The key of the current object.

p: The new object position.

Returns

An HOperatorReturn indicating the status of the event.
virtual int HSubwindow::ObjectScaledEvent(HBaseView *view, HC_KEY key, HPoint &scale)

virtual

This method handles the object scaled event by updating the size of the subwindow with the given scale parameter.

Parameters

view: A pointer to the HBaseView object.

key: The key of the current object.

scale: The object scaling.

Returns

An HOperatorReturn indicating the status of the event.
static char const *HSubwindow::GetStaticName()

static

Returns

The name of the object which is ‘subwindow’.
void HSubwindow::GetParameters()

protected

This method retrieves the window parameters from the window segment key.

bool HSubwindow::IsInSizeArea(HPoint &point)

protected

This method determine if the mouse pointer is in the resizing area.

Parameters

point: The position of the mouse pointer.

Returns

True if it is in the resize area or false if it is not or the appearance does not have the SW_SIZE_FIELD flag.
bool HSubwindow::IsInMagnifyArea(HPoint &point)

protected

This method determines if the mouse pointer is in magnifying slider area.

Parameters

point: The position of the mouse pointer.

Returns

True if it is in the magnifying slider area or false if it is not or the appearance doesn’t have the SW_MAGNIFIER_FIELD.
void HSubwindow::CopyViewLight(HBaseView *view)

protected

This method copies the light associated with the view to the subwindow.

Parameters

view: A pointer to the HBaseView object.
void HSubwindow::BuildMagnifyController(float pos)

protected

This method constructs a magnifier slider for the window if the appearance has the SW_MAGNIFIER_FIELD.

Parameters

pos: The initial position of the slider.
void HSubwindow::ChangeMagnification(HBaseView *view, HPoint &p)

protected

This method changes the subwindow’s manification based on the position of the magnification slider.

Parameters

view: A pointer to the HBaseView object.

p: The slider position.

void HSubwindow::Magnify(HBaseView *view)

protected

This method performs magnification on the window.

Parameters

view: A pointer to the HBaseView object.
void HSubwindow::ShowPointer()

protected

This method constructs the magnification/view pointer.

bool HSubwindow::IsInCloseArea(HPoint &point)

protected

This method determines if the mouse position is in the “close window” area.

Parameters

point: The mouse position.

Returns

True if it is in the “close window” area or false if it is not or the appearance does not have the flag SW_DELETE_FIELD.
bool HSubwindow::IsInDragArea(HPoint &point)

protected

This method determines if the mouse position is in the mouse drag area.

Parameters

point: The mouse position.

Returns

True if it is in the magnifying slider area or false if it is not or the appearance does not have the SW_DRAG_FIELD flag.
void HSubwindow::BuildBorder()

protected

This method constructs a window border area if the appearance has the SW_BORDER flag.

bool HSubwindow::IsInMoveArea(HPoint &point)

protected

This method determines if the mouse pointer is in the move area.

Parameters

point: The position of the mouse pointer.

Returns

True if the mouse is in the move area or false if it isn’t or the appearance does not have the SW_MOVE_FIELD flag.
void HSubwindow::ChangeMagnification(HBaseView *view, float magnification)

protected

This method adjusts the subwindow’s magnification.

Parameters

view: A pointer to the HBaseView object.

magnification: The magnification level.

void HSubwindow::MakeKeyframe()

protected

This method creates a subwindow movement keyframe.

void HSubwindow::MakeScaleKeyframe()

protected

This method creates a subwindow scaling keyframe.

Variables

HC_KEY HSubwindow::m_OuterKey

protected

HC_KEY

The top level key for the window.

HC_KEY HSubwindow::m_WindowKey

protected

HC_KEY

The key to the “window” segment.

float HSubwindow::m_Left

protected

float

The minimum horizontal value of the subwindow in window coordinates.

float HSubwindow::m_Right

protected

float

The maximum horizontal value of the subwindow in window coordinates.

float HSubwindow::m_Bottom

protected

float

The maximum vertical value of the subwindow in window coordinates.

float HSubwindow::m_Top

protected

float

The minimum vertical value of the subwindow in window coordinates.

int HSubwindow::m_Type

protected

int

The window type which can be SUBWINDOW_NOTYPE, SUBWINDOW_MAGNIFIER, SUBWINDOW_SNAPSHOT or SUBWINDOW_POINTER.

float HSubwindow::m_Magnification

protected

float

The window magnification level.

float HSubwindow::m_OldMagnification

protected

float

The previous magnification field.

long HSubwindow::m_Appearance

protected

long

The appearance bitfield which can be any combination of the following: SW_BORDER, SW_SIZE_FIELD, SW_MOVE_FIELD, SW_DRAG_FIELD, SW_DELETE_FIELD, SW_MAGNIFIER_FIELD, SW_BACKGROUND_BOX.

HPoint HSubwindow::m_Pointer

protected

The location of the window pointer.

int HSubwindow::m_Action

protected

int

The current window action which can be SW_ACTION_NOACTION, SW_ACTION_MOVE, SW_ACTION_SIZING, SW_ACTION_MAGNIFYING, SW_ACTION_POINTERMOVE or SW_ACTION_DRAGGING.

HPoint HSubwindow::m_ptLast

protected

The last mouse position.