Open CASCADE Technology 6.5.2
Public Member Functions
Graphic2d_HidingGraphicObject Class Reference

Creates a 2D hiding graphic object in a view.
A graphic object is a primitives manager
which hide the others graphic objects

#include <Graphic2d_HidingGraphicObject.hxx>

Inheritance diagram for Graphic2d_HidingGraphicObject:
Inheritance graph
[legend]

Public Member Functions

 Graphic2d_HidingGraphicObject (const Handle< Graphic2d_View > &aView, const Graphic2d_Array1OfVertex &aFrame)
 Creates an hiding polygon object in the view <aView>
This graphic object manages a sequence of primitives.
<aFrame> describes the hiding polygon geometry
The frame is created with the default attributes :
* the hiding color index : 0 (the same as the view)
* the frame color index : 1
* the frame line type index : 0
* the frame line thickness index : 0
* the graphic object is :

 Graphic2d_HidingGraphicObject (const Handle< Graphic2d_View > &aView, const Graphic2d_TypeOfFrame aType=Graphic2d_TOF_RECTANGULAR, const Quantity_Length aMargin1=0.0, const Quantity_Length aMargin2=0.0)
 Creates an hiding predefined object in the view <aView>.
the predefined TypeOfFrame must be one of :
TOF_RECTANGULAR,TOF_CIRCULAR.
the frame position and geometry is computed
automaticaly according to the contents of the
graphic object and the <aMargin1>,<aMargin2> parameter.
A graphic object manages a sequence of primitives.
Warning: The type of frame can be UNKNOWN,in this case the frame is
not drawn.

void SetFrame (const Graphic2d_Array1OfVertex &aFrame)
 Updates the frame geometry.

void SetFrame (const Graphic2d_TypeOfFrame aFrameType, const Quantity_Length aMargin1=0.0, const Quantity_Length aMargin2=0.0)
 Updates & computes the frame geometry
automaticaly according to the contents of the
graphic object and the <aMargin> parameter.
Warning: The type of frame can be UNKNOWN,in this case the frame is
not drawn.

void SetHidingColorIndex (const Standard_Integer anIndex=0)
 Updates the hiding color index of the background polygon.

void SetFrameColorIndex (const Standard_Integer anIndex=1)
 Updates the frame color index of the polygon.

void SetFrameTypeIndex (const Standard_Integer anIndex=0)
 Updates the frame line type index of the polygon.

void SetFrameWidthIndex (const Standard_Integer anIndex=0)
 Updates the frame line thickness index of the polygon.

virtual Standard_Integer MaxPriority () const
 Returns the max usable relative priority of the
"hiding" graphic object.

Standard_Boolean FrameMinMax (Quantity_Length &Minx, Quantity_Length &Maxx, Quantity_Length &Miny, Quantity_Length &Maxy) const
 Returns the min max values of the frame of <me>.
Warning: If <me> is empty
returns FALSE
and Minx = Miny = RealFirst ()
Maxx = Maxy = RealLast ()

virtual Standard_Boolean MinMax (Quantity_Length &Minx, Quantity_Length &Maxx, Quantity_Length &Miny, Quantity_Length &Maxy) const
 Returns the min max values of <me> including
the frame and primitives inside.
Warning: If <me> is empty or not displayed
returns FALSE
and Minx = Miny = RealFirst ()
Maxx = Maxy = RealLast ()

Graphic2d_TypeOfFrame Frame (Graphic2d_Array1OfVertex &aFrame) const
 Returns the frame geometry and type of
the hiding graphic object.
Warning: the frame can be NULL.

Standard_Integer HidingColorIndex () const
 Returns the hiding color index.

Standard_Integer FrameColorIndex () const
 Returns the frame color index.

Standard_Integer FrameTypeIndex () const
 Returns the frame line type index.

Standard_Integer FrameWidthIndex () const
 Returns the frame line thickness index.


Constructor & Destructor Documentation

Graphic2d_HidingGraphicObject::Graphic2d_HidingGraphicObject ( const Handle< Graphic2d_View > &  aView,
const Graphic2d_Array1OfVertex aFrame 
)
  • empty.
  • plottable.
  • drawable.
  • pickable.
  • not displayed.
  • not highlighted.
  • has a relative drawing priority of 0
Graphic2d_HidingGraphicObject::Graphic2d_HidingGraphicObject ( const Handle< Graphic2d_View > &  aView,
const Graphic2d_TypeOfFrame  aType = Graphic2d_TOF_RECTANGULAR,
const Quantity_Length  aMargin1 = 0.0,
const Quantity_Length  aMargin2 = 0.0 
)

Member Function Documentation

Graphic2d_TypeOfFrame Graphic2d_HidingGraphicObject::Frame ( Graphic2d_Array1OfVertex aFrame) const
Standard_Integer Graphic2d_HidingGraphicObject::FrameColorIndex ( ) const
Standard_Boolean Graphic2d_HidingGraphicObject::FrameMinMax ( Quantity_Length Minx,
Quantity_Length Maxx,
Quantity_Length Miny,
Quantity_Length Maxy 
) const
Standard_Integer Graphic2d_HidingGraphicObject::FrameTypeIndex ( ) const
Standard_Integer Graphic2d_HidingGraphicObject::FrameWidthIndex ( ) const
Standard_Integer Graphic2d_HidingGraphicObject::HidingColorIndex ( ) const
virtual Standard_Integer Graphic2d_HidingGraphicObject::MaxPriority ( ) const [virtual]

Reimplemented from Graphic2d_GraphicObject.

virtual Standard_Boolean Graphic2d_HidingGraphicObject::MinMax ( Quantity_Length Minx,
Quantity_Length Maxx,
Quantity_Length Miny,
Quantity_Length Maxy 
) const [virtual]

Reimplemented from Graphic2d_GraphicObject.

void Graphic2d_HidingGraphicObject::SetFrame ( const Graphic2d_TypeOfFrame  aFrameType,
const Quantity_Length  aMargin1 = 0.0,
const Quantity_Length  aMargin2 = 0.0 
)
void Graphic2d_HidingGraphicObject::SetFrame ( const Graphic2d_Array1OfVertex aFrame)
void Graphic2d_HidingGraphicObject::SetFrameColorIndex ( const Standard_Integer  anIndex = 1)
void Graphic2d_HidingGraphicObject::SetFrameTypeIndex ( const Standard_Integer  anIndex = 0)
void Graphic2d_HidingGraphicObject::SetFrameWidthIndex ( const Standard_Integer  anIndex = 0)
void Graphic2d_HidingGraphicObject::SetHidingColorIndex ( const Standard_Integer  anIndex = 0)

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines