Open CASCADE Technology 6.6.0
Public Member Functions
AIS_Axis Class Reference

Locates the x, y and z axes in an Interactive Object.
These are used to orient it correctly in presentations
from different viewpoints, or to construct a revolved
shape, for example, from one of the axes. Conversely,
an axis can be created to build a revolved shape and
then situated relative to one of the axes of the view.

#include <AIS_Axis.hxx>

Inheritance diagram for AIS_Axis:
Inheritance graph
[legend]

Public Member Functions

 AIS_Axis (const Handle< Geom_Line > &aComponent)
 Initializes the line aComponent

 AIS_Axis (const Handle< Geom_Axis2Placement > &aComponent, const AIS_TypeOfAxis anAxisType)
 initializes the axis2 position
aComponent. The coordinate system used is right-handed.

 AIS_Axis (const Handle< Geom_Axis1Placement > &anAxis)
 Initializes the axis1 position anAxis.

const Handle_Geom_Line & Component () const
 Returns the axis entity aComponent and identifies it
as a component of a shape.

void SetComponent (const Handle< Geom_Line > &aComponent)
 Sets the coordinates of the lin aComponent.

const Handle_Geom_Axis2Placement & Axis2Placement () const
 Returns the position of axis2 and positions it by
identifying it as the x, y, or z axis and giving its
direction in 3D space. The coordinate system used is right-handed.

void SetAxis2Placement (const Handle< Geom_Axis2Placement > &aComponent, const AIS_TypeOfAxis anAxisType)
 Allows you to provide settings for aComponent:the
position and direction of an axis in 3D space. The
coordinate system used is right-handed.

void SetAxis1Placement (const Handle< Geom_Axis1Placement > &anAxis)
 Constructs a new line to serve as the axis anAxis in 3D space.

AIS_TypeOfAxis TypeOfAxis () const
 Returns the type of axis.

void SetTypeOfAxis (const AIS_TypeOfAxis aTypeAxis)
 Constructs the entity aTypeAxis to stock information
concerning type of axis.

Standard_Boolean IsXYZAxis () const
 Returns a signature of 2 for axis datums. When you
activate mode 2 by a signature, you pick AIS objects
of type AIS_Axis.

Standard_Boolean AcceptDisplayMode (const Standard_Integer aMode) const
 Returns true if the interactive object accepts the display mode aMode.

virtual 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 !!!

virtual Standard_Integer Signature () const
 Specifies additional characteristics of Interactive
Objects. A signature is, in fact, an index with integer
values assigned different properties.
This method is frequently used in conjuction with
Type to give a particular type and signature to an
Interactive Object. By default, the Interactive Object
has a None type and a signature of 0. Among the
datums, this signature is attributed to the shape
The remaining datums have the following default signatures:

virtual AIS_KindOfInteractive Type () const
 Returns the kind of Interactive Object:

void SetColor (const Quantity_NameOfColor aColor)
 only the interactive obj knowns which Drawer attribute
is affected by the color (ex: for a wire, it's the
wireaspect field of the drawer, but for a vertex, only
the point aspect field is affected by the color)
WARNING : Do not forget to set the corresponding fields
here (hasOwnColor and myOwnColor)

void SetColor (const Quantity_Color &aColor)
void SetWidth (const Standard_Real aValue)
 Allows you to provide the setting aValue for width.
Only the Interactive Object knows which Drawer
attribute is affected by the width setting.

void UnsetColor ()
 Removes color settings. Only the Interactive Object
knows which Drawer attribute is affected by the color
setting. For a wire, for example, wire aspect is the
attribute affected. For a vertex, however, only point
aspect is affected by the color setting.

void UnsetWidth ()

Constructor & Destructor Documentation

AIS_Axis::AIS_Axis ( const Handle< Geom_Line > &  aComponent)
AIS_Axis::AIS_Axis ( const Handle< Geom_Axis2Placement > &  aComponent,
const AIS_TypeOfAxis  anAxisType 
)
AIS_Axis::AIS_Axis ( const Handle< Geom_Axis1Placement > &  anAxis)

Member Function Documentation

Standard_Boolean AIS_Axis::AcceptDisplayMode ( const Standard_Integer  aMode) const [virtual]

Reimplemented from AIS_InteractiveObject.

const Handle_Geom_Axis2Placement& AIS_Axis::Axis2Placement ( ) const
const Handle_Geom_Line& AIS_Axis::Component ( ) const
virtual void AIS_Axis::Compute ( const Handle< Prs3d_Projector > &  aProjector,
const Handle< Geom_Transformation > &  aTrsf,
const Handle< Prs3d_Presentation > &  aPresentation 
) [virtual]

Reimplemented from PrsMgr_PresentableObject.

Standard_Boolean AIS_Axis::IsXYZAxis ( ) const
void AIS_Axis::SetAxis1Placement ( const Handle< Geom_Axis1Placement > &  anAxis)
void AIS_Axis::SetAxis2Placement ( const Handle< Geom_Axis2Placement > &  aComponent,
const AIS_TypeOfAxis  anAxisType 
)
void AIS_Axis::SetColor ( const Quantity_NameOfColor  aColor) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Axis::SetColor ( const Quantity_Color aColor) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Axis::SetComponent ( const Handle< Geom_Line > &  aComponent)
void AIS_Axis::SetTypeOfAxis ( const AIS_TypeOfAxis  aTypeAxis)
void AIS_Axis::SetWidth ( const Standard_Real  aValue) [virtual]

Reimplemented from AIS_InteractiveObject.

virtual Standard_Integer AIS_Axis::Signature ( ) const [virtual]
  • Point signature 1
  • Axis signature 2
  • Trihedron signature 3
  • PlaneTrihedron signature 4
  • Line signature 5
  • Circle signature 6
  • Plane signature 7.

Reimplemented from AIS_InteractiveObject.

virtual AIS_KindOfInteractive AIS_Axis::Type ( ) const [virtual]
  • None
  • Datum
  • Relation
  • Object
    By default, the interactive object has a None type.
    Because specific shapes entail different behavior
    according to their sub-shapes, you may need to
    create a Local Context. This will allow you to
    specify the additional characteristics which you
    need to handle these shapes.

Reimplemented from AIS_InteractiveObject.

AIS_TypeOfAxis AIS_Axis::TypeOfAxis ( ) const
void AIS_Axis::UnsetColor ( ) [virtual]

Reimplemented from AIS_InteractiveObject.

void AIS_Axis::UnsetWidth ( ) [virtual]

Reimplemented from AIS_InteractiveObject.


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