Interface for AIS_InteractiveObject. More...

Inheritance diagram for GeomAPI_AISObject:

Public Member Functions
GEOMAPI_EXPORT	GeomAPI_AISObject ()
	Creation of empty AIS object. More...

GEOMAPI_EXPORT void	createShape (std::shared_ptr< GeomAPI_Shape > theShape)
	Creates AIS_Shape object using specified shape. More...

GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Shape >	getShape () const
	Returns shape used for the presentation creation (can be NULL) More...

GEOMAPI_EXPORT void	createDistance (std::shared_ptr< GeomAPI_Pnt > theStartPoint, std::shared_ptr< GeomAPI_Pnt > theEndPoint, std::shared_ptr< GeomAPI_Pnt > theFlyoutPoint, std::shared_ptr< GeomAPI_Pln > thePlane, double theDistance)
	Creates PrsDim_LengthDimension object. More...

GEOMAPI_EXPORT bool	isEmptyDistanceGeometry ()
	Returns validity of the AIS distance. More...

GEOMAPI_EXPORT void	createRadius (std::shared_ptr< GeomAPI_Circ > theCircle, std::shared_ptr< GeomAPI_Pnt > theFlyoutPoint, double theRadius)
	Creates PrsDim_RadiusDimension object. More...

GEOMAPI_EXPORT void	createParallel (std::shared_ptr< GeomAPI_Shape > theLine1, std::shared_ptr< GeomAPI_Shape > theLine2, std::shared_ptr< GeomAPI_Pnt > theFlyoutPoint, std::shared_ptr< GeomAPI_Pln > thePlane)
	Creates PrsDim_ParallelRelation object for two lines. More...

GEOMAPI_EXPORT void	createPerpendicular (std::shared_ptr< GeomAPI_Shape > theLine1, std::shared_ptr< GeomAPI_Shape > theLine2, std::shared_ptr< GeomAPI_Pln > thePlane)
	Creates PrsDim_PerpendicularRelation object for two lines. More...

GEOMAPI_EXPORT void	createFixed (std::shared_ptr< GeomAPI_Shape > theShape, std::shared_ptr< GeomAPI_Pln > thePlane)
	Creates PrsDim_FixedRelation object for an object. More...

GEOMAPI_EXPORT void	setColor (const int &theColor)
	Assigns the color for the shape. More...

GEOMAPI_EXPORT bool	setColor (int theR, int theG, int theB)
	Assigns the color for the shape. More...

GEOMAPI_EXPORT bool	setColor (const std::shared_ptr< GeomAPI_Shape > &theSubShape, int theR, int theG, int theB)
	Assigns the color for the subshape. More...

GEOMAPI_EXPORT void	getColor (int &theR, int &theG, int &theB)
	Returns the color for the shape. More...

GEOMAPI_EXPORT bool	setDeflection (const double theDeflection)
	Assigns the deflection to the shape. More...

GEOMAPI_EXPORT double	getDeflection () const
	Returns deflection for the shape. More...

GEOMAPI_EXPORT bool	setTransparency (const double theTransparency)
	Assigns the transparency to the shape. More...

GEOMAPI_EXPORT double	getTransparency () const
	Returns deflection for the shape. More...

GEOMAPI_EXPORT double	width ()

GEOMAPI_EXPORT bool	setWidth (const double &theWidth)
	Assigns the width of the lines of shape. More...

GEOMAPI_EXPORT bool	empty () const
	Checks if the object is empty. More...

GEOMAPI_EXPORT int	getShapeType () const
	Return shape type according to TopAbs_ShapeEnum if the AIS is AIS_Shape Otherwise returns -1. More...

GEOMAPI_EXPORT void	setPointMarker (int theType, double theScale)
	Sets marker type for vertex. More...

GEOMAPI_EXPORT bool	setLineStyle (int theStyle)
	Set line type of edges Has to be defined according to Aspect_TypeOfLine. More...

GEOMAPI_EXPORT bool	setTransparensy (double theVal)
	Set transparency of the presentation (theVal = 0 ... More...

template<class T >
T *	implPtr ()
	Returns the pointer to the impl. More...

template<class T >
const T *	implPtr () const
	Returns the pointer to the impl. More...

template<class T >
const T &	impl () const
	Returns the reference object of the impl. More...

template<class T >
void	setImpl (T *theImpl)
	Updates the impl (deletes the old one) More...

Detailed Description

Interface for AIS_InteractiveObject.

Constructor & Destructor Documentation

◆ GeomAPI_AISObject()

GeomAPI_AISObject::GeomAPI_AISObject ( )

Creation of empty AIS object.

the text selection tolerance

Member Function Documentation

◆ createShape()

void GeomAPI_AISObject::createShape ( std::shared_ptr< GeomAPI_Shape > theShape )

Creates AIS_Shape object using specified shape.

◆ getShape()

std::shared_ptr< GeomAPI_Shape > GeomAPI_AISObject::getShape ( ) const

Returns shape used for the presentation creation (can be NULL)

◆ createDistance()

void GeomAPI_AISObject::createDistance	(	std::shared_ptr< GeomAPI_Pnt >	theStartPoint,
		std::shared_ptr< GeomAPI_Pnt >	theEndPoint,
		std::shared_ptr< GeomAPI_Pnt >	theFlyoutPoint,
		std::shared_ptr< GeomAPI_Pln >	thePlane,
		double	theDistance
	)

Creates PrsDim_LengthDimension object.

Parameters

[in]	theStartPoint	first point for dimension
[in]	theEndPoint	second point for dimension
[in]	theFlyoutPoint	the flyout of dimension relative to the measured line
[in]	thePlane	the plane which contains all points above
[in]	theDistance	value of the distance to be shown

◆ isEmptyDistanceGeometry()

bool GeomAPI_AISObject::isEmptyDistanceGeometry ( )

Returns validity of the AIS distance.

It is invalid if set measured geometry is not valid, e.g. the distance points are equal.

Returns: a boolean result

◆ createRadius()

void GeomAPI_AISObject::createRadius	(	std::shared_ptr< GeomAPI_Circ >	theCircle,
		std::shared_ptr< GeomAPI_Pnt >	theFlyoutPoint,
		double	theRadius
	)

Creates PrsDim_RadiusDimension object.

Parameters

[in]	theCircle	the radius is created for this circle
[in]	theFlyoutPoint	the flyout of dimension
[in]	theRadius	value of the radius to be shown

◆ createParallel()

void GeomAPI_AISObject::createParallel	(	std::shared_ptr< GeomAPI_Shape >	theLine1,
		std::shared_ptr< GeomAPI_Shape >	theLine2,
		std::shared_ptr< GeomAPI_Pnt >	theFlyoutPoint,
		std::shared_ptr< GeomAPI_Pln >	thePlane
	)

Creates PrsDim_ParallelRelation object for two lines.

Parameters

[in]	theLine1	first parallel line
[in]	theLine2	second parallel line
[in]	theFlyoutPoint	the flyout point for relation
[in]	thePlane	the plane which contains the lines

◆ createPerpendicular()

void GeomAPI_AISObject::createPerpendicular	(	std::shared_ptr< GeomAPI_Shape >	theLine1,
		std::shared_ptr< GeomAPI_Shape >	theLine2,
		std::shared_ptr< GeomAPI_Pln >	thePlane
	)

Creates PrsDim_PerpendicularRelation object for two lines.

Parameters

[in]	theLine1	first parallel line
[in]	theLine2	second parallel line
[in]	thePlane	the plane which contains the lines

◆ createFixed()

void GeomAPI_AISObject::createFixed	(	std::shared_ptr< GeomAPI_Shape >	theShape,
		std::shared_ptr< GeomAPI_Pln >	thePlane
	)

Creates PrsDim_FixedRelation object for an object.

Parameters

[in]	theShape	the object
[in]	thePlane	the plane which contains the lines

◆ setColor() [1/3]

void GeomAPI_AISObject::setColor ( const int & theColor )

Assigns the color for the shape.

Parameters

[in] theColor index of the color

◆ setColor() [2/3]

bool GeomAPI_AISObject::setColor	(	int	theR,
		int	theG,
		int	theB
	)

Assigns the color for the shape.

Parameters

[in]	theR	value of the red component
[in]	theG	value of the green component
[in]	theB	value of the blue component

Returns: true if the presentation color is changed

◆ setColor() [3/3]

bool GeomAPI_AISObject::setColor	(	const std::shared_ptr< GeomAPI_Shape > &	theSubShape,
		int	theR,
		int	theG,
		int	theB
	)

Assigns the color for the subshape.

Parameters

[in]	theSubShape	subshape that belongs to shape
[in]	theR	value of the red component
[in]	theG	value of the green component
[in]	theB	value of the blue component

◆ getColor()

void GeomAPI_AISObject::getColor	(	int &	theR,
		int &	theG,
		int &	theB
	)

Returns the color for the shape.

Parameters

[in]	theR	value of the red component
[in]	theG	value of the green component
[in]	theB	value of the blue component

◆ setDeflection()

bool GeomAPI_AISObject::setDeflection ( const double theDeflection )

Assigns the deflection to the shape.

Parameters

[in] theDeflection value of deflection

◆ getDeflection()

double GeomAPI_AISObject::getDeflection ( ) const

Returns deflection for the shape.

Returns: double value

◆ setTransparency()

bool GeomAPI_AISObject::setTransparency ( const double theTransparency )

Assigns the transparency to the shape.

Parameters

[in] theTransparency value of transparency

◆ getTransparency()

double GeomAPI_AISObject::getTransparency ( ) const

Returns deflection for the shape.

Returns: double value

◆ width()

double GeomAPI_AISObject::width ( )

Returns: Current width of the lines of shape

◆ setWidth()

bool GeomAPI_AISObject::setWidth ( const double & theWidth )

Assigns the width of the lines of shape.

◆ empty()

bool GeomAPI_AISObject::empty ( ) const

Checks if the object is empty.

◆ getShapeType()

int GeomAPI_AISObject::getShapeType ( ) const

Return shape type according to TopAbs_ShapeEnum if the AIS is AIS_Shape Otherwise returns -1.

◆ setPointMarker()

void GeomAPI_AISObject::setPointMarker	(	int	theType,
		double	theScale
	)

Sets marker type for vertex.

The type has to be defined according to Acpect_TypeOfMarker

◆ setLineStyle()

bool GeomAPI_AISObject::setLineStyle ( int theStyle )

Set line type of edges Has to be defined according to Aspect_TypeOfLine.

Returns: true if the object value differs from the current

◆ setTransparensy()

bool GeomAPI_AISObject::setTransparensy ( double theVal )

Set transparency of the presentation (theVal = 0 ...

1)

Returns: true if the object value differs from the current

◆ implPtr() [1/2]

template<class T >

T* GeomAPI_Interface::implPtr ( )

inlineinherited

Returns the pointer to the impl.

◆ implPtr() [2/2]

template<class T >

const T* GeomAPI_Interface::implPtr ( ) const

inlineinherited

Returns the pointer to the impl.

◆ impl()

template<class T >

const T& GeomAPI_Interface::impl ( ) const

inlineinherited

Returns the reference object of the impl.

◆ setImpl()

template<class T >

void GeomAPI_Interface::setImpl ( T * theImpl )

inlineinherited

Updates the impl (deletes the old one)

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GeomAPI_AISObject()

Member Function Documentation

◆ createShape()

◆ getShape()

◆ createDistance()

◆ isEmptyDistanceGeometry()

◆ createRadius()

◆ createParallel()

◆ createPerpendicular()

◆ createFixed()

◆ setColor() [1/3]

◆ setColor() [2/3]

◆ setColor() [3/3]

◆ getColor()

◆ setDeflection()

◆ getDeflection()

◆ setTransparency()

◆ getTransparency()

◆ width()

◆ setWidth()

◆ empty()

◆ getShapeType()

◆ setPointMarker()

◆ setLineStyle()

◆ setTransparensy()

◆ implPtr() [1/2]

◆ implPtr() [2/2]

◆ impl()

◆ setImpl()