PoXtAxisEditor Class Reference
[Editors]

MeshViz Abstract class for axes editors. More...

#include <MeshViz/graph/editors/PoXtAxisEditor.h>

Inheritance diagram for PoXtAxisEditor:
SoXtComponent PoXtAngularAxisEditor PoXtCartesianAxisEditor PoXtPolarAxisEditor PoXtTimeAxisEditor PoXtGenAxisEditor PoXtLinearAxisEditor PoXtLogAxisEditor PoXtPolarLinAxisEditor PoXtPolarLogAxisEditor

List of all members.

Public Types

enum  TextAxisMask {
  NO_TEXT_MASK = 0x00000000,
  GRAD_VISIBILITY = 0x00000001,
  GRAD_POSITION = 0x00000002,
  GRAD_PATH = 0x00000004,
  GRAD_FONT_NAME = 0x00000008,
  GRAD_FONT_SIZE = 0x00000010,
  GRAD_DIST_AXIS = 0x00000020,
  GRAD_ADD_STRING_VISIBILITY = 0x00000040,
  GRAD_ADD_STRING = 0x00000080,
  GRAD,
  TITLE_VISIBILITY = 0x00000100,
  TITLE_POSITION = 0x00000200,
  TITLE_PATH = 0x00000400,
  TITLE_FONT_NAME = 0x00000800,
  TITLE_FONT_SIZE = 0x00001000,
  TITLE_DIST_AXIS = 0x00002000,
  TITLE_STRING = 0x00004000,
  TITLE,
  REVERSE_FLAG = 0x00008000,
  MISC_TEXT_ATTR = 0x00010000,
  ALL_TEXT_MASK = GRAD | TITLE | REVERSE_FLAG | MISC_TEXT_ATTR
}
enum  GeomAxisMask {
  NO_GEOM_MASK = 0x00000000,
  MARGIN_TYPE = 0x00000001,
  MARGIN_START = 0x00000002,
  MARGIN_END = 0x00000004,
  MARGIN,
  GRID_VISIBILITY = 0x00000008,
  GRID_LENGTH_GRAD_SIDE = 0x00000010,
  GRID_LENGTH_GRAD_OTHER_SIDE = 0x00000020,
  GRID,
  ARROW_VISIBILITY = 0x00000040,
  ARROW_HEIGHT = 0x00000080,
  ARROW_LENGTH = 0x00000100,
  ARROW,
  TICK_VISIBILITY = 0x00000200,
  TICK_POSITION = 0x00000400,
  TICK_MAIN_LENGTH = 0x00000800,
  TICK_SUB_LENGTH = 0x00001000,
  TICK_SUB_DEF = 0x00002000,
  TICK_NUM_OR_PERIOD = 0x00004000,
  TICK_FIRST_GRAD = 0x00008000,
  TICK_LAST_GRAD = 0x00010000,
  TICK_ALL,
  ALL_GEOM_MASK = MARGIN | GRID | ARROW | TICK_ALL
}
enum  Presentation {
  TOGGLE_FOLD,
  TOGGLE_UNFOLD,
  LABEL_UNFOLD
}
enum  UpdateFrequency {
  CONTINUOUS,
  AFTER_ACCEPT
}
typedef void PoXtAxisEditorCB (void *userData, PoAxis *data)

Public Member Functions

virtual void attach (PoAxis *axis)
void detach ()
SbBool isAttached () const
void addAxisChangedCallback (PoXtAxisEditorCB *func, void *userData)
void removeAxisChangedCallback (PoXtAxisEditorCB *func, void *userData)
virtual void setPresentation (Presentation type)
Presentation getPresentation () const
void setUpdateFrequency (UpdateFrequency freq)
UpdateFrequency getUpdateFrequency () const
void setTextAxisFilter (unsigned long inclusionMask, unsigned long exclusionMask)
void getTextAxisFilter (unsigned long &inclusionMask, unsigned long &exclusionMask) const
void setGeomAxisFilter (unsigned long inclusionMask, unsigned long exclusionMask)
void getGeomAxisFilter (unsigned long &inclusionMask, unsigned long &exclusionMask) const
virtual void show ()
virtual void hide ()

Detailed Description

MeshViz Abstract class for axes editors.

NOTE: This class does not exist in Open Inventor 10.0 and later.

Deprecated:

Deprecated since Open Inventor 9600
MeshViz editors are no longer supported.

Member Typedef Documentation

typedef void PoXtAxisEditor::PoXtAxisEditorCB(void *userData, PoAxis *data)

Member Enumeration Documentation

Enumerator:
NO_GEOM_MASK 
MARGIN_TYPE 
MARGIN_START 
MARGIN_END 
MARGIN 
GRID_VISIBILITY 
GRID_LENGTH_GRAD_SIDE 
GRID_LENGTH_GRAD_OTHER_SIDE 
GRID 
ARROW_VISIBILITY 
ARROW_HEIGHT 
ARROW_LENGTH 
ARROW 
TICK_VISIBILITY 
TICK_POSITION 
TICK_MAIN_LENGTH 
TICK_SUB_LENGTH 
TICK_SUB_DEF 
TICK_NUM_OR_PERIOD 
TICK_FIRST_GRAD 
TICK_LAST_GRAD 
TICK_ALL 
ALL_GEOM_MASK 
Enumerator:
TOGGLE_FOLD 
TOGGLE_UNFOLD 
LABEL_UNFOLD 
Enumerator:
NO_TEXT_MASK 
GRAD_VISIBILITY 
GRAD_POSITION 
GRAD_PATH 
GRAD_FONT_NAME 
GRAD_FONT_SIZE 
GRAD_DIST_AXIS 
GRAD_ADD_STRING_VISIBILITY 
GRAD_ADD_STRING 
GRAD 
TITLE_VISIBILITY 

GRAD is a family mask, thus:.

GRAD = GRAD_VISIBILITY | ... | GRAD_ADD_STRING

TITLE_POSITION 
TITLE_PATH 
TITLE_FONT_NAME 
TITLE_FONT_SIZE 
TITLE_DIST_AXIS 
TITLE_STRING 
TITLE 
REVERSE_FLAG 
MISC_TEXT_ATTR 
ALL_TEXT_MASK 

Type of update.

Enumerator:
CONTINUOUS 

Updates the attached object at each modification.

AFTER_ACCEPT 

Updates the attached object when hitting the accept button.


Member Function Documentation

void PoXtAxisEditor::addAxisChangedCallback ( PoXtAxisEditorCB func,
void *  userData 
)

Addscallbacks which are called on axis changes.

(See the method setUpdateFrequency to define the moment when the callbacks are called).

virtual void PoXtAxisEditor::attach ( PoAxis axis  )  [virtual]

Attach the editor to an axis node.

void PoXtAxisEditor::detach (  ) 

Detach the editor from an axis node.

void PoXtAxisEditor::getGeomAxisFilter ( unsigned long &  inclusionMask,
unsigned long &  exclusionMask 
) const

Gets editing filters defining which geometry axis attributes will be displayed in the editor.

Presentation PoXtAxisEditor::getPresentation (  )  const

Gets the presentation of the editor.

void PoXtAxisEditor::getTextAxisFilter ( unsigned long &  inclusionMask,
unsigned long &  exclusionMask 
) const

Gets editing filters defining which text axis attributes will be displayed in the editor.

UpdateFrequency PoXtAxisEditor::getUpdateFrequency (  )  const

Gets the update frequency.

virtual void PoXtAxisEditor::hide (  )  [virtual]

This hides the component.

Reimplemented from SoXtComponent.

SbBool PoXtAxisEditor::isAttached (  )  const

Returns TRUE if the editor is attached.

void PoXtAxisEditor::removeAxisChangedCallback ( PoXtAxisEditorCB func,
void *  userData 
)

Removes the callbacks called on axis changes.

void PoXtAxisEditor::setGeomAxisFilter ( unsigned long  inclusionMask,
unsigned long  exclusionMask 
)

Sets editing filters defining which geometry axis attributes will be displayed in the editor.

(By default inclusionMask = ALL_GEOM_MASK and exclusionMask = NO_GEOM_MASK)

virtual void PoXtAxisEditor::setPresentation ( Presentation  type  )  [virtual]

Sets the presentation of the editor.

(type = TOGGLE_FOLD by default).

void PoXtAxisEditor::setTextAxisFilter ( unsigned long  inclusionMask,
unsigned long  exclusionMask 
)

Sets editing filters defining which text axis attributes will be displayed in the editor.

(By default inclusionMask = ALL_TEXT_MASK and exclusionMask = NO_TEXT_MASK).

void PoXtAxisEditor::setUpdateFrequency ( UpdateFrequency  freq  ) 

Sets the update frequency.

(By default freq = CONTINUOUS).

virtual void PoXtAxisEditor::show (  )  [virtual]

This shows the component.

Reimplemented from SoXtComponent.


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

Open Inventor by FEI reference manual, generated on 2 Sep 2019
Copyright © FEI S.A.S. All rights reserved.
http://www.openinventor.com/