#include <ViewerTest.hxx>

Static Public Member Functions
static void	Factory (Draw_Interpretor &theDI)
	Loads all Draw commands of V2d & V3d. Used for plugin.

static TCollection_AsciiString	ViewerInit (const ViewerTest_VinitParams &theParams)
	Creates view with default or custom name and adds this name in map to manage multiple views. Implemented in ViewerTest_ViewerCommands.cxx.

static TCollection_AsciiString	ViewerInit (const TCollection_AsciiString &theViewName="")
	Creates view.

static TCollection_AsciiString	ViewerInit (const Standard_Integer thePxLeft, const Standard_Integer thePxTop, const Standard_Integer thePxWidth, const Standard_Integer thePxHeight, const TCollection_AsciiString &theViewName, const TCollection_AsciiString &theDisplayName="", const Handle< V3d_View > &theViewToClone=Handle< V3d_View >(), const Standard_Boolean theIsVirtual=false)
	Creates view.

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	ActivateView (const Handle< V3d_View > &theView, Standard_Boolean theToUpdate)
	Make the view active.

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.

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.

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.

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

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>

static void	Commands (Draw_Interpretor &theCommands)

static void	ViewerCommands (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_Viewer >	GetViewerFromContext ()

static Handle< V3d_Viewer >	GetCollectorFromContext ()

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)

static void	UnsetEventManager ()
	removes the last EventManager from the list.

static void	ResetEventManager ()
	clear the list of EventManagers and sets the default EventManager as current

static Handle< ViewerTest_EventManager >	CurrentEventManager ()

static void	RemoveSelected ()

static void	RedrawAllViews ()
	redraws all defined views.

static Standard_Boolean	SplitParameter (const TCollection_AsciiString &theString, TCollection_AsciiString &theName, TCollection_AsciiString &theValue)
	Splits "parameter=value" string into separate parameter and value strings.

static void	GetSelectedShapes (TopTools_ListOfShape &theShapes)
	Returns list of selected shapes.

static Standard_Boolean	ParseLineType (Standard_CString theArg, Aspect_TypeOfLine &theType, uint16_t &thePattern)
	Parses line type argument. Handles either enumeration (integer) value or string constant.

static Standard_Boolean	ParseLineType (Standard_CString theArg, Aspect_TypeOfLine &theType)
	Parses line type argument. Handles either enumeration (integer) value or string constant.

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.

static Standard_Boolean	ParseShadingModel (Standard_CString theArg, Graphic3d_TypeOfShadingModel &theModel)
	Parses shading model argument. Handles either enumeration (integer) value or string constant.

static Standard_Boolean	ParseZLayerName (Standard_CString theArg, Graphic3d_ZLayerId &theLayer)
	Parses ZLayer name.

static Standard_Boolean	ParseZLayer (Standard_CString theArg, Graphic3d_ZLayerId &theLayer)
	Parses ZLayer name.

static Standard_Boolean	ParseCorner (Standard_CString theArg, Aspect_TypeOfTriedronPosition &theCorner)
	Auxiliary method to parse transformation persistence flags.

deprecated methods
static Standard_Integer	ParseColor (const Standard_Integer theArgNb, const char const const theArgVec, Quantity_ColorRGBA &theColor)
	Parses RGB(A) color argument(s) specified within theArgVec[0], theArgVec[1], theArgVec[2] and theArgVec[3].

static Standard_Integer	ParseColor (const Standard_Integer theArgNb, const char const const theArgVec, Quantity_Color &theColor)
	Parses RGB color argument(s). Returns number of handled arguments (1 or 3) or 0 on syntax error.

static Standard_Boolean	ParseOnOff (Standard_CString theArg, Standard_Boolean &theIsOn)
	Parses boolean argument. Handles either flag specified by 0\|1 or on\|off.

static Quantity_NameOfColor	GetColorFromName (const Standard_CString name)

Member Function Documentation

◆ ActivateView()

static void ViewerTest::ActivateView	(	const Handle< V3d_View > &	theView,
		Standard_Boolean	theToUpdate
	)

static

Make the view active.

◆ 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

theName	key to be associated to displayed interactive object
theObject	object to display
theToUpdate	redraw viewer after displaying object
theReplaceIfExists	replace 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

Deprecated:: ("Method has been moved to Quantity_Color::ColorFromName()")

◆ 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

◆ 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	(	const Standard_Integer	theArgNb,
		const char const const	theArgVec,
		Quantity_Color &	theColor
	)

static

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

Deprecated:: ("Method has been moved to Draw::ParseColor()")

◆ ParseColor() [2/2]

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

static

Parses RGB(A) color argument(s) specified within theArgVec[0], theArgVec[1], theArgVec[2] and theArgVec[3].

Deprecated:: ("Method has been moved to Draw::ParseColor()")

◆ ParseCorner()

static Standard_Boolean ViewerTest::ParseCorner	(	Standard_CString	theArg,
		Aspect_TypeOfTriedronPosition &	theCorner
	)

static

Auxiliary method to parse transformation persistence flags.

◆ ParseLineType() [1/2]

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

inlinestatic

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

◆ ParseLineType() [2/2]

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

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.

Deprecated:: ("Method has been moved to Draw::ParseOnOff()")

◆ 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 Handle< V3d_View > &	theView,
		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 TCollection_AsciiString &	theViewName,
		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() [1/3]

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

inlinestatic

Creates view.

◆ ViewerInit() [2/3]

static TCollection_AsciiString ViewerTest::ViewerInit ( const TCollection_AsciiString & theViewName = "" )

inlinestatic

Creates view.

◆ ViewerInit() [3/3]

static TCollection_AsciiString ViewerTest::ViewerInit ( const ViewerTest_VinitParams & theParams )

static

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

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

ViewerTest.hxx

Static Public Member Functions

deprecated methods

Member Function Documentation

◆ ActivateView()

◆ Clear()

◆ Commands()

◆ CurrentEventManager()

◆ CurrentView() [1/2]

◆ CurrentView() [2/2]

◆ Display()

◆ Factory()

◆ FilletCommands()

◆ GetAISContext()

◆ GetCollectorFromContext()

◆ GetColorFromName()

◆ GetCurrentViewName()

◆ GetMousePosition()

◆ GetSelectedShapes()

◆ GetViewerFromContext()

◆ InitViewName()

◆ ObjectCommands()

◆ OpenGlCommands()

◆ ParseColor() [1/2]

◆ ParseColor() [2/2]

◆ ParseCorner()

◆ ParseLineType() [1/2]

◆ ParseLineType() [2/2]

◆ ParseMarkerType()

◆ ParseOnOff()

◆ ParseShadingModel()

◆ ParseZLayer()

◆ ParseZLayerName()

◆ PickShape()

◆ PickShapes()

◆ RedrawAllViews()

◆ RelationCommands()

◆ RemoveSelected()

◆ RemoveView() [1/2]

◆ RemoveView() [2/2]

◆ RemoveViewName()

◆ ResetEventManager()

◆ SetAISContext()

◆ SetEventManager()

◆ SplitParameter()

◆ UnsetEventManager()

◆ ViewerCommands()

◆ ViewerInit() [1/3]

◆ ViewerInit() [2/3]

◆ ViewerInit() [3/3]