OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
AIS


AIS_Point Class Reference

Constructs point datums to be used in construction of
composite shapes. The datum is displayed as the plus marker +.
.

#include <AIS_Point.hxx>

Inheritance diagram for AIS_Point:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT AIS_Point (const Handle(Geom_Point)&aComponent)
 Initializes the point aComponent from which the point
datum will be built.
.
virtual Standard_Integer Signature () const
 Returns index 1, the default index for a point.
.
virtual AIS_KindOfInteractive Type () const
 Indicates that a point is a datum.
.
Standard_EXPORT Handle_Geom_Point Component ()
 Returns the component specified in SetComponent.
.
Standard_EXPORT void SetComponent (const Handle(Geom_Point)&aComponent)
 Constructs an instance of the point aComponent.
.
Standard_EXPORT Standard_Boolean AcceptDisplayMode (const Standard_Integer aMode) const
 Returns true if the display mode selected is valid for point datums.
.
virtual Standard_EXPORT void Compute (const Handle(Prs3d_Projector)&aProjector, const Handle(Geom_Transformation)&aTrsf, const Handle(Prs3d_Presentation)&aPresentation)
 computes the presentation according to a point of view
given by <aprojector>.
To be Used when the associated degenerated Presentations
have been transformed by <atrsf> which is not a Pure
Translation. The HLR Prs can't be deducted automatically
WARNING :<atrsf> must be applied
to the object to display before computation !!!

Standard_EXPORT void SetColor (const Quantity_NameOfColor aColor)
 Allows you to provide settings for the cp;pr aColor.
.
Standard_EXPORT void SetColor (const Quantity_Color &aColor)
Standard_EXPORT void UnsetColor ()
 Allows you to remove color settings.
.
Standard_EXPORT void SetMarker (const Aspect_TypeOfMarker aType)
 Allows you to provide settings for a marker. These include
- type of marker,
- marker color,
- scale factor.
.
Standard_EXPORT void UnsetMarker ()
 Removes the marker settings.
.
Standard_Boolean HasMarker () const
 Returns true if the point datum has a marker.
.
Standard_EXPORT TopoDS_Vertex Vertex () const
 Converts a point into a vertex.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Member Functions

Standard_EXPORT void Compute (const Handle(PrsMgr_PresentationManager3d)&aPresentationManager, const Handle(Prs3d_Presentation)&aPresentation, const Standard_Integer aMode=0)
 Calculates the 3D view aPresentation and its
updates. The latter are managed by aPresentationManager.
aPresentableObject has the display mode aMode;
this has the default value of 0, that is, the wireframe display mode.
.
Standard_EXPORT void Compute (const Handle(Prs3d_Projector)&aProjector, const Handle(Prs3d_Presentation)&aPresentation)
 Calculates the 3D view aPresentation and its
updates. The latter are managed by
aPresentationManager. Each of the views in the
viewer and every modification such as rotation, for
example, entails recalculation.
It must be redefined to implement hidden line removal
for the object. The user never calls this method
himself. This is done via the InteractiveContext object
and is dependent on the point of view from which the
object is displayed.
.
Standard_EXPORT void Compute (const Handle(PrsMgr_PresentationManager2d)&aPresentationManager, const Handle(Graphic2d_GraphicObject)&aPresentation, const Standard_Integer aMode=0)
 Calculates the 2D view aPresentation and its
updates. The latter are managed by aPresentationManager.
aPresentableObject has the display mode aMode;
this has the default value of 0, that is, the wireframe display mode.
Note that this syntax is not used in AIS as that
package only concerns 3D display.
.
Standard_EXPORT void ComputeSelection (const Handle(SelectMgr_Selection)&aSelection, const Standard_Integer aMode)
 Recovers and calculates any sensitive primitive,
aSelection, available in Shape mode, specified by
aMode. As a rule, these are sensitive faces.
This method is defined as virtual. This enables you to
implement it in the creation of a new class of AIS
Interactive Object. You need to do this and in so
doing, redefine this method, if you create a class
which enriches the list of signatures and types.
.
Standard_EXPORT void UpdatePointValues ()

Private Attributes

Handle_Geom_Point myComponent
Standard_Boolean myHasTOM
Aspect_TypeOfMarker myTOM

Constructor & Destructor Documentation

Standard_EXPORT AIS_Point::AIS_Point const Handle(Geom_Point)&  aComponent  ) 
 


Member Function Documentation

Standard_EXPORT Standard_Boolean AIS_Point::AcceptDisplayMode const Standard_Integer  aMode  )  const [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT Handle_Geom_Point AIS_Point::Component  ) 
 

Standard_EXPORT void AIS_Point::Compute const Handle(PrsMgr_PresentationManager2d)&  aPresentationManager,
const Handle(Graphic2d_GraphicObject)&  aPresentation,
const Standard_Integer  aMode = 0
[private, virtual]
 

Reimplemented from PrsMgr_PresentableObject.

Standard_EXPORT void AIS_Point::Compute const Handle(Prs3d_Projector)&  aProjector,
const Handle(Prs3d_Presentation)&  aPresentation
[private, virtual]
 

Reimplemented from PrsMgr_PresentableObject.

Standard_EXPORT void AIS_Point::Compute const Handle(PrsMgr_PresentationManager3d)&  aPresentationManager,
const Handle(Prs3d_Presentation)&  aPresentation,
const Standard_Integer  aMode = 0
[private, virtual]
 

Reimplemented from PrsMgr_PresentableObject.

virtual Standard_EXPORT void AIS_Point::Compute const Handle(Prs3d_Projector)&  aProjector,
const Handle(Geom_Transformation)&  aTrsf,
const Handle(Prs3d_Presentation)&  aPresentation
[virtual]
 

Reimplemented from PrsMgr_PresentableObject.

Standard_EXPORT void AIS_Point::ComputeSelection const Handle(SelectMgr_Selection)&  aSelection,
const Standard_Integer  aMode
[private, virtual]
 

Implements SelectMgr_SelectableObject.

Standard_EXPORT const AIS_Point::Handle Standard_Type   )  const
 

Reimplemented from AIS_InteractiveObject.

Standard_Boolean AIS_Point::HasMarker  )  const [inline]
 

Standard_EXPORT void AIS_Point::SetColor const Quantity_Color &  aColor  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Point::SetColor const Quantity_NameOfColor  aColor  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Point::SetComponent const Handle(Geom_Point)&  aComponent  ) 
 

Standard_EXPORT void AIS_Point::SetMarker const Aspect_TypeOfMarker  aType  ) 
 

Standard_Integer AIS_Point::Signature  )  const [inline, virtual]
 

Reimplemented from AIS_InteractiveObject.

AIS_KindOfInteractive AIS_Point::Type  )  const [inline, virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Point::UnsetColor  )  [virtual]
 

Reimplemented from AIS_InteractiveObject.

Standard_EXPORT void AIS_Point::UnsetMarker  ) 
 

Standard_EXPORT void AIS_Point::UpdatePointValues  )  [private]
 

Standard_EXPORT TopoDS_Vertex AIS_Point::Vertex  )  const
 


Field Documentation

Handle_Geom_Point AIS_Point::myComponent [private]
 

Standard_Boolean AIS_Point::myHasTOM [private]
 

Aspect_TypeOfMarker AIS_Point::myTOM [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:55:17 2008 for OpenCASCADE by  doxygen 1.4.1