CATDmrOpnsSectionInterfaces Interface CATIOpnsSection
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIOpnsSection
This interface CATIOpnsSection enables to manage a section done between a plane and
productstructure loaded in session.
The computation of the result is based on a solver which take into
account tesselated geometry.
It allows you to set or get the position of plane, the mode of render (clipping or no), and export
a section result in a new part.
Method Index
- o
Export(CATIMmiUsePrtPart*)
- Export the result of the section between plane positioned and product structure,
in a Part.
- o
GetPlanePosition(CATMathPlane*)
- Gets the position of the section.
- o
GetSceneRender(CatSceneRenderMode*)
- Gets the scene render mode of the section.
- o
IsEmpty(CATBoolean&)
- Allow to determine if a section contains results or not.
- o
SetPlaneDimensions(double,double)
- Set the dimension of the plane.
- o
SetPlanePosition(CATMathPlane)
- Sets the position of the section.
- o
SetSceneRender(CatSceneRenderMode)
- Sets the scene render mode of the section.
Methods
o Export
| public virtual Export( | | ioPart) |
-
Export the result of the section between plane positioned and product structure,
in a Part.
- Parameters:
-
- ioPart
- The part in which the geometry of section will be saved as sketch polyline.
The part should be created before call of export method.
- Returns:
- S_OK for persistent section else E_FAIL
o GetPlanePosition
| public virtual GetPlanePosition( | | oPlanePos) |
-
Gets the position of the section.
- Parameters:
-
- oPlanePos
- Position of plane and section with respect to the absolute coordinate system
- Returns:
- S_OK if succeeded else E_FAIL
o GetSceneRender
| public virtual GetSceneRender( | | opSRenderMode) |
-
Gets the scene render mode of the section. NO_CLIPPING or CLIPPING
- Parameters:
-
- opSRenderMode
- It can be valued with NO_CLIPPING or CLIPPING
- Returns:
- S_OK if succeeded else E_FAIL
o IsEmpty
| public virtual IsEmpty( | | ioIsEmpty) |
-
Allow to determine if a section contains results or not.
- Parameters:
-
- ioIsEmpty
- TRUE if the section is empty, FALSE otherwise.
- Returns:
- S_OK if everthing is OK, E_FAIL otherwise.
o SetPlaneDimensions
| public virtual SetPlaneDimensions( | | ioWidth, |
| | ioHeight) |
-
Set the dimension of the plane.
The plane will be center to the center of the plane defined by the method SetPlanePosition.
The width and the height will allow to control the dimension of the plane.
width
/----------------/
/ /
/ /
/ X / Height
/ Center /
/ /
/ /
/----------------/
- Parameters:
-
- ioWidth
- the width of the plane.
- ioHeight
- the height of the plane.
- Returns:
- S_OK if everthing is OK, E_FAIL otherwise.
o SetPlanePosition
| public virtual SetPlanePosition( | | iPlanePosition) |
-
Sets the position of the section.
- Parameters:
-
- iPlanePosition
- Position of the plane and section with respect to the absolute coordinate system
- Returns:
- S_OK if succeeded else E_FAIL
o SetSceneRender
| public virtual SetSceneRender( | | iSRenderMode) |
-
Sets the scene render mode of the section.
- Parameters:
-
- iSceneRender
- It can be valued with NO_CLIPPING or CLIPPING
- Returns:
- S_OK if succeeded else E_FAIL
This object is included in the file: CATIOpnsSection.h
If needed, your Imakefile.mk should include the module: CATDmrOpnsSectionItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.