Open CASCADE Technology  7.3.1.dev
Static Public Member Functions
ViewerTest Class Reference

#include <ViewerTest.hxx>

Static Public Member Functions

static void Factory (Draw_Interpretor &theDI)
 Loads all Draw commands of V2d & V3d. Used for plugin. More...
 
static TCollection_AsciiString ViewerInit (const Standard_Integer thePxLeft=0, const Standard_Integer thePxTop=0, const Standard_Integer thePxWidth=0, const Standard_Integer thePxHeight=0, const TCollection_AsciiString &theViewName="", const TCollection_AsciiString &theDisplayName="", const Handle< V3d_View > &theViewToClone=Handle< V3d_View >())
 Creates view with default or custom name and adds this name in map to manage multiple views. Implemented in ViewerTest_ViewerCommands.cxx. More...
 
static void RemoveViewName (const TCollection_AsciiString &theName)
 
static void InitViewName (const TCollection_AsciiString &theName, const Handle< V3d_View > &theView)
 
static TCollection_AsciiString GetCurrentViewName ()
 
static void RemoveView (const TCollection_AsciiString &theViewName, const Standard_Boolean theToRemoveContext=Standard_True)
 Removes view and clear all maps with information about its resources if necessary. More...
 
static void RemoveView (const Handle< V3d_View > &theView, const Standard_Boolean theToRemoveContext=Standard_True)
 Removes view and clear all maps with information about its resources if necessary. More...
 
static Standard_Boolean Display (const TCollection_AsciiString &theName, const Handle< AIS_InteractiveObject > &theObject, const Standard_Boolean theToUpdate=Standard_True, const Standard_Boolean theReplaceIfExists=Standard_True)
 Display AIS object in active Viewer and register it in the map of Interactive Objects with specified name. More...
 
static TopoDS_Shape PickShape (const TopAbs_ShapeEnum aType, const Standard_Integer MaxPick=5)
 waits until a shape of type <aType> is picked in the AIS Viewer and returns it. if <aType> == TopAbs_Shape, any shape can be picked... MaxPick is the Max number before exiting, if no pick is successful More...
 
static Standard_Boolean PickShapes (const TopAbs_ShapeEnum aType, Handle< TopTools_HArray1OfShape > &thepicked, const Standard_Integer MaxPick=5)
 wait until the array is filled with picked shapes. returns True if the array is filled. exit if number of unsuccessful picks = <MaxPick> More...
 
static void Commands (Draw_Interpretor &theCommands)
 
static void ViewerCommands (Draw_Interpretor &theCommands)
 
static void MyCommands (Draw_Interpretor &theCommands)
 
static void RelationCommands (Draw_Interpretor &theCommands)
 
static void ObjectCommands (Draw_Interpretor &theCommands)
 
static void FilletCommands (Draw_Interpretor &theCommands)
 
static void OpenGlCommands (Draw_Interpretor &theCommands)
 
static void GetMousePosition (Standard_Integer &xpix, Standard_Integer &ypix)
 
static Handle< V3d_ViewerGetViewerFromContext ()
 
static Handle< V3d_ViewerGetCollectorFromContext ()
 
static const Handle< AIS_InteractiveContext > & GetAISContext ()
 
static void SetAISContext (const Handle< AIS_InteractiveContext > &aContext)
 
static const Handle< V3d_View > & CurrentView ()
 
static void CurrentView (const Handle< V3d_View > &aViou)
 
static void Clear ()
 
static void SetEventManager (const Handle< ViewerTest_EventManager > &theMgr)
 puts theMgr as current eventmanager (the move,select,...will be applied to theMgr) More...
 
static void UnsetEventManager ()
 removes the last EventManager from the list. More...
 
static void ResetEventManager ()
 clear the list of EventManagers and sets the default EventManager as current More...
 
static Handle< ViewerTest_EventManagerCurrentEventManager ()
 
static void RemoveSelected ()
 
static Quantity_NameOfColor GetColorFromName (const Standard_CString name)
 
static Standard_Integer ParseColor (Standard_Integer theArgNb, const char **theArgVec, Quantity_ColorRGBA &theColor)
 Parses RGB(A) color argument(s) specified within theArgVec[0], theArgVec[1], theArgVec[2] and theArgVec[3]. Handles either color specified by name (single argument) or by RGB(A) components (3-4 arguments) in range 0..1. The result is stored in theColor on success. Returns number of handled arguments (1, 3 or 4) or 0 on syntax error. More...
 
static Standard_Integer ParseColor (Standard_Integer theArgNb, const char **theArgVec, Quantity_Color &theColor)
 Parses RGB color argument(s). Returns number of handled arguments (1 or 3) or 0 on syntax error. More...
 
static void RedrawAllViews ()
 redraws all defined views. More...
 
static Standard_Boolean SplitParameter (const TCollection_AsciiString &theString, TCollection_AsciiString &theName, TCollection_AsciiString &theValue)
 Splits "parameter=value" string into separate parameter and value strings. More...
 
static Standard_Boolean ParseOnOff (Standard_CString theArg, Standard_Boolean &theIsOn)
 Parses boolean argument. Handles either flag specified by 0|1 or on|off. More...
 
static void GetSelectedShapes (TopTools_ListOfShape &theShapes)
 Returns list of selected shapes. More...
 
static Standard_Boolean ParseLineType (Standard_CString theArg, Aspect_TypeOfLine &theType)
 Parses line type argument. Handles either enumeration (integer) value or string constant. More...
 
static Standard_Boolean ParseMarkerType (Standard_CString theArg, Aspect_TypeOfMarker &theType, Handle< Image_PixMap > &theImage)
 Parses marker type argument. Handles either enumeration (integer) value or string constant. More...
 
static Standard_Boolean ParseShadingModel (Standard_CString theArg, Graphic3d_TypeOfShadingModel &theModel)
 Parses shading model argument. Handles either enumeration (integer) value or string constant. More...
 
static Standard_Boolean ParseZLayerName (Standard_CString theArg, Graphic3d_ZLayerId &theLayer)
 Parses ZLayer name. More...
 
static Standard_Boolean ParseZLayer (Standard_CString theArg, Graphic3d_ZLayerId &theLayer)
 Parses ZLayer name. More...
 

Member Function Documentation

◆ Clear()

static void ViewerTest::Clear ( )
static

◆ Commands()

static void ViewerTest::Commands ( Draw_Interpretor theCommands)
static

◆ CurrentEventManager()

static Handle< ViewerTest_EventManager > ViewerTest::CurrentEventManager ( )
static

◆ CurrentView() [1/2]

static const Handle< V3d_View >& ViewerTest::CurrentView ( )
static

◆ CurrentView() [2/2]

static void ViewerTest::CurrentView ( const Handle< V3d_View > &  aViou)
static

◆ Display()

static Standard_Boolean ViewerTest::Display ( const TCollection_AsciiString theName,
const Handle< AIS_InteractiveObject > &  theObject,
const Standard_Boolean  theToUpdate = Standard_True,
const Standard_Boolean  theReplaceIfExists = Standard_True 
)
static

Display AIS object in active Viewer and register it in the map of Interactive Objects with specified name.

Parameters
theNamekey to be associated to displayed interactive object
theObjectobject to display
theToUpdateredraw viewer after displaying object
theReplaceIfExistsreplace the object assigned to specified key
Returns
true if new object has been displayed

◆ Factory()

static void ViewerTest::Factory ( Draw_Interpretor theDI)
static

Loads all Draw commands of V2d & V3d. Used for plugin.

◆ FilletCommands()

static void ViewerTest::FilletCommands ( Draw_Interpretor theCommands)
static

◆ GetAISContext()

static const Handle< AIS_InteractiveContext >& ViewerTest::GetAISContext ( )
static

◆ GetCollectorFromContext()

static Handle< V3d_Viewer > ViewerTest::GetCollectorFromContext ( )
static

◆ GetColorFromName()

static Quantity_NameOfColor ViewerTest::GetColorFromName ( const Standard_CString  name)
static

◆ GetCurrentViewName()

static TCollection_AsciiString ViewerTest::GetCurrentViewName ( )
static

◆ GetMousePosition()

static void ViewerTest::GetMousePosition ( Standard_Integer xpix,
Standard_Integer ypix 
)
static

◆ GetSelectedShapes()

static void ViewerTest::GetSelectedShapes ( TopTools_ListOfShape theShapes)
static

Returns list of selected shapes.

◆ GetViewerFromContext()

static Handle< V3d_Viewer > ViewerTest::GetViewerFromContext ( )
static

◆ InitViewName()

static void ViewerTest::InitViewName ( const TCollection_AsciiString theName,
const Handle< V3d_View > &  theView 
)
static

◆ MyCommands()

static void ViewerTest::MyCommands ( Draw_Interpretor theCommands)
static

◆ ObjectCommands()

static void ViewerTest::ObjectCommands ( Draw_Interpretor theCommands)
static

◆ OpenGlCommands()

static void ViewerTest::OpenGlCommands ( Draw_Interpretor theCommands)
static

◆ ParseColor() [1/2]

static Standard_Integer ViewerTest::ParseColor ( Standard_Integer  theArgNb,
const char **  theArgVec,
Quantity_ColorRGBA theColor 
)
inlinestatic

Parses RGB(A) color argument(s) specified within theArgVec[0], theArgVec[1], theArgVec[2] and theArgVec[3]. Handles either color specified by name (single argument) or by RGB(A) components (3-4 arguments) in range 0..1. The result is stored in theColor on success. Returns number of handled arguments (1, 3 or 4) or 0 on syntax error.

◆ ParseColor() [2/2]

static Standard_Integer ViewerTest::ParseColor ( Standard_Integer  theArgNb,
const char **  theArgVec,
Quantity_Color theColor 
)
inlinestatic

Parses RGB color argument(s). Returns number of handled arguments (1 or 3) or 0 on syntax error.

◆ ParseLineType()

static Standard_Boolean ViewerTest::ParseLineType ( Standard_CString  theArg,
Aspect_TypeOfLine theType 
)
static

Parses line type argument. Handles either enumeration (integer) value or string constant.

◆ ParseMarkerType()

static Standard_Boolean ViewerTest::ParseMarkerType ( Standard_CString  theArg,
Aspect_TypeOfMarker theType,
Handle< Image_PixMap > &  theImage 
)
static

Parses marker type argument. Handles either enumeration (integer) value or string constant.

◆ ParseOnOff()

static Standard_Boolean ViewerTest::ParseOnOff ( Standard_CString  theArg,
Standard_Boolean theIsOn 
)
static

Parses boolean argument. Handles either flag specified by 0|1 or on|off.

◆ ParseShadingModel()

static Standard_Boolean ViewerTest::ParseShadingModel ( Standard_CString  theArg,
Graphic3d_TypeOfShadingModel theModel 
)
static

Parses shading model argument. Handles either enumeration (integer) value or string constant.

◆ ParseZLayer()

static Standard_Boolean ViewerTest::ParseZLayer ( Standard_CString  theArg,
Graphic3d_ZLayerId theLayer 
)
inlinestatic

Parses ZLayer name.

Parameters
theArg[in] layer name, enumeration alias or index (of existing Layer)
theLayer[out] layer index
Returns
TRUE if layer has been identified, note that Graphic3d_ZLayerId_UNKNOWN is also valid value

◆ ParseZLayerName()

static Standard_Boolean ViewerTest::ParseZLayerName ( Standard_CString  theArg,
Graphic3d_ZLayerId theLayer 
)
inlinestatic

Parses ZLayer name.

Parameters
theArg[in] layer name or enumeration alias
theLayer[out] layer index
Returns
TRUE if layer has been identified, note that Graphic3d_ZLayerId_UNKNOWN is also valid value

◆ PickShape()

static TopoDS_Shape ViewerTest::PickShape ( const TopAbs_ShapeEnum  aType,
const Standard_Integer  MaxPick = 5 
)
static

waits until a shape of type <aType> is picked in the AIS Viewer and returns it. if <aType> == TopAbs_Shape, any shape can be picked... MaxPick is the Max number before exiting, if no pick is successful

◆ PickShapes()

static Standard_Boolean ViewerTest::PickShapes ( const TopAbs_ShapeEnum  aType,
Handle< TopTools_HArray1OfShape > &  thepicked,
const Standard_Integer  MaxPick = 5 
)
static

wait until the array is filled with picked shapes. returns True if the array is filled. exit if number of unsuccessful picks = <MaxPick>

◆ RedrawAllViews()

static void ViewerTest::RedrawAllViews ( )
static

redraws all defined views.

◆ RelationCommands()

static void ViewerTest::RelationCommands ( Draw_Interpretor theCommands)
static

◆ RemoveSelected()

static void ViewerTest::RemoveSelected ( )
static

◆ RemoveView() [1/2]

static void ViewerTest::RemoveView ( const TCollection_AsciiString theViewName,
const Standard_Boolean  theToRemoveContext = Standard_True 
)
static

Removes view and clear all maps with information about its resources if necessary.

◆ RemoveView() [2/2]

static void ViewerTest::RemoveView ( const Handle< V3d_View > &  theView,
const Standard_Boolean  theToRemoveContext = Standard_True 
)
static

Removes view and clear all maps with information about its resources if necessary.

◆ RemoveViewName()

static void ViewerTest::RemoveViewName ( const TCollection_AsciiString theName)
static

◆ ResetEventManager()

static void ViewerTest::ResetEventManager ( )
static

clear the list of EventManagers and sets the default EventManager as current

◆ SetAISContext()

static void ViewerTest::SetAISContext ( const Handle< AIS_InteractiveContext > &  aContext)
static

◆ SetEventManager()

static void ViewerTest::SetEventManager ( const Handle< ViewerTest_EventManager > &  theMgr)
static

puts theMgr as current eventmanager (the move,select,...will be applied to theMgr)

◆ SplitParameter()

static Standard_Boolean ViewerTest::SplitParameter ( const TCollection_AsciiString theString,
TCollection_AsciiString theName,
TCollection_AsciiString theValue 
)
static

Splits "parameter=value" string into separate parameter and value strings.

Returns
TRUE if the string matches pattern "<string>=<empty or string>"

◆ UnsetEventManager()

static void ViewerTest::UnsetEventManager ( )
static

removes the last EventManager from the list.

◆ ViewerCommands()

static void ViewerTest::ViewerCommands ( Draw_Interpretor theCommands)
static

◆ ViewerInit()

static TCollection_AsciiString ViewerTest::ViewerInit ( const Standard_Integer  thePxLeft = 0,
const Standard_Integer  thePxTop = 0,
const Standard_Integer  thePxWidth = 0,
const Standard_Integer  thePxHeight = 0,
const TCollection_AsciiString theViewName = "",
const TCollection_AsciiString theDisplayName = "",
const Handle< V3d_View > &  theViewToClone = HandleV3d_View >() 
)
static

Creates view with default or custom name and adds this name in map to manage multiple views. Implemented in ViewerTest_ViewerCommands.cxx.

Parameters
thePxLeftleft position of newly created window
thePxToptop position of newly created window
thePxWidthwidth of newly created window
thePxHeightheight of newly created window
theViewNamename of newly created View theDisplayName display name
theViewToClonewhen specified, the new View will copy properties of existing one

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