# HOpFramedAnnotate

## Functions

| `HOpFramedAnnotate`
| `~HOpFramedAnnotate`
const char * | `GetName`
int | `OnLButtonDown`
int | `OnLButtonDownAndMove`
int | `OnLButtonUp`
int | `OnKeyDown`
HBaseOperator * | `Clone`

## Detailed Description

class HOpFramedAnnotate : public HBaseOperator

  Public Functions

  HOpFramedAnnotate(HBaseView *view, bool bAddToLayer = false, int DoRepeat = 0, int DoCapture = 1)
  ~HOpFramedAnnotate()
  virtual const char *GetName()
    Returns

      A character pointer denoting the name of operator.

  virtual int OnLButtonDown(HEventInfo &hevent)

    The derived operator should overload this function to intercept and handle the case where the left mouse button has been pressed down. It will be automatically called from the HOOPS/GUI toolkit when such an event occurs, and should be manually called by platform-specific UI code if HOOPS/GUI is not being used.

    Parameters

      hevent – An HEventInfo object containing information about the current event

    Returns

      An HOperatorReturn indicating the status of the event.

  virtual int OnLButtonDownAndMove(HEventInfo &hevent)

    The derived operator should overload this function to intercept and handle the case where the left mouse button is pressed down and the mouse has moved. It will be automatically called from the HOOPS/GUI toolkit when such an event occurs, and should be manually called by platform-specific UI code if HOOPS/GUI is not being used.

    Parameters

      hevent – An HEventInfo object containing information about the current event

    Returns

      An HOperatorReturn indicating the status of the event.

  virtual int OnLButtonUp(HEventInfo &hevent)

    The derived operator should overload this function to intercept and handle the case where the left mouse button has been released. It will be automatically called from the HOOPS/GUI toolkit when such an event occurs, and should be manually called by platform-specific UI code if HOOPS/GUI is not being used.

    Parameters

      hevent – An HEventInfo object containing information about the current event

    Returns

      An HOperatorReturn indicating the status of the event.

  virtual int OnKeyDown(HEventInfo &hevent)

    The derived operator should overload this function to intercept and handle the case where a keyboard key has been pressed down. It will be automatically called from the HOOPS/GUI toolkit when such an event occurs, and should be manually called by platform-specific UI code if HOOPS/GUI is not being used.

    Parameters

      hevent – An HEventInfo object containing information about the current event

    Returns

      An HOperatorReturn indicating the status of the event.

  virtual HBaseOperator *Clone()

    Creates a new operator which is associated with the same view as the current operator. The user is responsible for deleting the newly created operator.

    Returns

      A pointer to an HBaseOperator object