Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Attributes
AIS2D_InteractiveObject Class Reference

Class Interactive Object defines a class of objects
with display and selection services.
Using visualization and selection machanisms,
interactive objects are used to display datum, curves,
shapes, markers, dimensions, etc. Interactive objects
also provide links to the interactive context.

#include <AIS2D_InteractiveObject.hxx>

Inheritance diagram for AIS2D_InteractiveObject:
Inheritance graph
[legend]

Public Member Functions

 AIS2D_InteractiveObject ()
 Initialize the Interactive Object

Handle_Prs2d_Drawer Attributes () const
 Returns the attributes settings

virtual void SetAttributes (const Handle< Prs2d_Drawer > &aDrawer)
 Initializes the drawing tool <aDrawer>

virtual void UnsetAttributes ()
 Clears settings provided by the drawing tool <aDrawer>

void SetAspect (const Handle< Prs2d_AspectRoot > &anAspect)
 Sets the attributes from Aspect <anAspect>
to all primitives appropriate this Aspect.

void SetAspect (const Handle< Prs2d_AspectRoot > &anAspect, const Handle< Graphic2d_Primitive > &aPrimitive)
 Sets the attributes from Aspect <anAspect>
to primitive <aPrimitive>
Method works only for objects are linked
with InteractiveContext

Handle_Prs2d_AspectRoot GetAspect (const Handle< Graphic2d_Primitive > &aPrimitive) const
 Returns Aspect for primitive <aPrimitive>
Method works only for objects are linked
with InteractiveContext

Standard_Boolean HasAspect (const Handle< Graphic2d_Primitive > &aPrimitive) const
 Returns true if primitive <aPrimitive>
is linked with an aspect


Standard_Boolean HasInteractiveContext () const
 Indicates whether the Interactive Object has a pointer
to an interactive context.

Handle_AIS2D_InteractiveContext GetContext () const
 Returns the context pointer to the interactive context.

virtual void SetContext (const Handle< AIS2D_InteractiveContext > &aCntx)
 Places a link to <aCnTx>. The drawer of AIS2D_InteractiveObject
is connected to the Default Drawer Of <aCntx>.
That Means that this method has to be redefined if
computations depend on drawer values.

Standard_Integer DisplayMode () const
 Indicates the display mode of the Interactive Object

Standard_Boolean HasDisplayMode () const
 Returns True if the Interactive Object has
a display mode setting. Otherwise, it is
displayed in Neutral Point.

void SetDisplayMode (const Standard_Integer aMode)
 Allows to provide a setting <aMode> for an
Interactive Object's display mode.

void UnsetDisplayMode ()
 Removes display mode settings from the Interactive object

virtual Standard_Integer DefaultDisplayMode () const
 Returns the default display mode. This method is to be
implemented when the main mode is not mode 0.

virtual Standard_Boolean AcceptDisplayMode (const Standard_Integer aMode) const
 Returns true if the class of objects accepts the display mode <aMode>

AIS2D_TypeOfDetection HighlightMode () const
 Returns the setting for highlight mode.

Standard_Boolean HasHighlightMode () const
 Returns true if the Interactive Object is in highlight mode

void SetHighlightMode (const AIS2D_TypeOfDetection aMode)
 Allows to provide settings for highlight mode.

void UnsetHighlightMode ()
 Removes settings for highlight mode

virtual AIS2D_TypeOfDetection DefaultHighlightMode () const
 Returns the default highlight mode

Standard_Integer SelectionMode () const
 Indicates the selection mode of the Interactive Object

Standard_Boolean HasSelectionMode () const
 Allows you to change the selection mode of an Interactive Object

void SetSelectionMode (const Standard_Integer aMode)
 Allows to provide a setting <aMode> for an
Interactive Object's selection mode.

void UnsetSelectionMode ()
 Removes settings for selection mode

virtual Standard_Integer DefaultSelectionMode () const
 Returns the default selection mode

Standard_Integer State () const
void SetState (const Standard_Integer aState)
void SelectPrimitive (const Standard_Integer anIndex, const Standard_Boolean append)
 Selects primitive with index( TOD_PRIMITIVE mode only )

virtual void Save (Aspect_FStream &aFStream) const
virtual void Retrieve (Aspect_IFStream &anIFStream) const

Protected Attributes

Handle_Prs2d_Drawer myDrawer
AIS2D_TypeOfDetection myHighlightMode

Constructor & Destructor Documentation


Member Function Documentation

Handle_Prs2d_Drawer AIS2D_InteractiveObject::Attributes ( ) const
Handle_Prs2d_AspectRoot AIS2D_InteractiveObject::GetAspect ( const Handle< Graphic2d_Primitive > &  aPrimitive) const
Handle_AIS2D_InteractiveContext AIS2D_InteractiveObject::GetContext ( ) const
virtual void AIS2D_InteractiveObject::Retrieve ( Aspect_IFStream anIFStream) const [virtual]
virtual void AIS2D_InteractiveObject::Save ( Aspect_FStream aFStream) const [virtual]

Field Documentation

Handle_Prs2d_Drawer AIS2D_InteractiveObject::myDrawer [protected]

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