CATTPSBaseUseItf Interface CATITPSCapture
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATITPSCapture
Interface to the Capture object.
Role: A Capture allows to define a group of TPS annotations ,and to
manage their visualisation (Hide/Show state, overloaded graphical properties).
When a capture is displayed , the associated TPS annotations get overloaded
according their properties.
All the TPSs which are grouped in the capture do not necesarily belong to
the same annotations set.
Method Index
- o
Get3DState(CATBoolean*)
- Retrieves the 3D State : display or not the capture.
- o
GetActiveView(CATITPSView**)
- Retrieves the active view for the capture.
- o
GetActiveViewState(CATBoolean*)
- Retrieves the Active View state, saved or Not.
- o
GetCamera(CATI3DCamera**)
- Retrieves the Camera that stores the viewpoint of the Capture.
- o
GetClippingPlane(CATBoolean*)
- Retrieves the clipping plane state, activated or Not.
- o
GetConstructedGeometry(CATIUnknownList**)
- Retrieves the Constructed Geometries that are visually managed by
this Capture.
- o
GetCurrent(CATBoolean*)
- Retrieves the Capture state, current or Not.
- o
GetHiddenText(wchar_t**)
- Retrieves the Hidden Text.
- o
GetManageHideShowBody(CATBoolean*)
- Retrieves the Setting Whether Part and Body Hide & Show
that are visually managed by this Capture.
- o
GetPartInstAndBody(CATIUnknownList**)
- Retrieves the Part Instances & Geometrical Feature Set
that are visually managed by this Capture.
- o
GetSet(CATITPSSet**)
- Retrieves tolerancing set the Capture belongs too.
- o
GetTPSViews(CATITPSViewList**)
- Retrieves the TPS Views that are visualy managed by this Capture.
- o
GetTPSs(CATITPSList**)
- Retrieves the TPSs that are visualy managed by this Capture.
- o
GetViewPoint(CATBoolean*)
- Retrieves the ViewPoint state, saved or Not.
- o
Set3DState(CATBoolean)
- Sets the 3D State : display or not the capture.
- o
SetActiveView(CATITPSView*)
- Sets the active view for the capture.
- o
SetActiveViewState(CATBoolean)
- Sets the Active View state, saved or Not.
- o
SetCamera(CATI3DCamera*)
- Sets the Camera that stores the viewpoint of the Capture.
- o
SetClippingPlane(CATBoolean)
- Sets the clipping plane state, activated or Not.
- o
SetConstructedGeometry(CATIUnknownList*)
- Sets the Constructed Geometries that are visualy managed by this Capture.
- o
SetCurrent(CATBoolean)
- Sets the Capture state, current or Not.
- o
SetHiddenText(wchar_t*)
- Sets the Hidden Text.
- o
SetManageHideShowBody(CATBoolean)
- Sets the Setting Whether Part and Body Hide & Show
that are visually managed by this Capture.
- o
SetPartInstAndBody(CATIUnknownList*)
- Sets the Part Instances & Geometrical Feature Set
that are visually managed by this Capture.
- o
SetTPSViews(CATITPSViewList*)
- Sets the TPS Views that are visualy managed by this Capture.
- o
SetTPSs(CATITPSList*)
- Sets the TPSs that are visualy managed by this Capture.
- o
SetViewPoint(CATBoolean)
- Sets the ViewPoint state, saved or Not.
Methods
o Get3DState
| public virtual Get3DState( | | ob3DState) |
-
Retrieves the 3D State : display or not the capture.
The 3D State describes the visualisation or not of the Capture in 3D
- Parameters:
-
- o3DState
- The 3D State.
o GetActiveView
| public virtual GetActiveView( | | opiActiveView) |
-
Retrieves the active view for the capture.
- Parameters:
-
- opiActiveView
- The View.
o GetActiveViewState
| public virtual GetActiveViewState( | | oActiveState) |
-
Retrieves the Active View state, saved or Not.
The Active View state describes what happens when Capture is displayed,
if TRUE, the active view of the tolerancing set is replaced by the
active view of the capture.
- Parameters:
-
- oActiveState
- The Active View state.
o GetCamera
| public virtual GetCamera( | | opiCamera) |
-
Retrieves the Camera that stores the viewpoint of the Capture.
- Parameters:
-
- opiCamera
- The Camera.
o GetClippingPlane
| public virtual GetClippingPlane( | | oClipPlane) |
-
Retrieves the clipping plane state, activated or Not.
The Clipping plane state describes what happens when Capture is
displayed, if TRUE, the active view is used to define a clipping plane.
If FALSE, there is no clipping plane applied.
- Parameters:
-
- oClipPlane
- The clipping plane state.
o GetConstructedGeometry
| public virtual GetConstructedGeometry( | | opiList) |
-
Retrieves the Constructed Geometries that are visually managed by
this Capture.
- Parameters:
-
- opiList
- List of managed TPSs.
o GetCurrent
| public virtual GetCurrent( | | oCurrentState) |
-
Retrieves the Capture state, current or Not.
- Parameters:
-
- oCurrentState
- Capture state. if TRUE the capture is current.that means that after
the creation of the capture, the future TPSs that would be added to
the CATIA document will belong to the capture.
o GetHiddenText
| public virtual GetHiddenText( | | opText) |
-
Retrieves the Hidden Text.
The Hidden Text is show when the mouse is on the Capture (in 3D or in the graph).
- Parameters:
-
- opText
- The Hidden Text.
o GetManageHideShowBody
| public virtual GetManageHideShowBody( | | obManageHideShowBody) |
-
Retrieves the Setting Whether Part and Body Hide & Show
that are visually managed by this Capture.
- Parameters:
-
- obManageHideShowBody
- TRUE If Hide & Show of Body to be Managed
FALSE If Hide & Show of Body is not to be Managed
o GetPartInstAndBody
| public virtual GetPartInstAndBody( | | opiList) |
-
Retrieves the Part Instances & Geometrical Feature Set
that are visually managed by this Capture.
- Parameters:
-
- opiList
- List of managed PartInstance & Geometrical Feature Set.
o GetSet
| public virtual GetSet( | | opiSet) |
-
Retrieves tolerancing set the Capture belongs too.
o GetTPSViews
| public virtual GetTPSViews( | | opiList) |
-
Retrieves the TPS Views that are visualy managed by this Capture.
- Parameters:
-
- opiList
- List of managed Views.
o GetTPSs
| public virtual GetTPSs( | | opiList) |
-
Retrieves the TPSs that are visualy managed by this Capture.
- Parameters:
-
- opiList
- List of managed TPSs.
o GetViewPoint
| public virtual GetViewPoint( | | oVPState) |
-
Retrieves the ViewPoint state, saved or Not.
The ViewPoint state describes what happens when Capture is displayed,
if TRUE, the 3D Camera of the Capture is used to change the 3D
ViewPoint.
- Parameters:
-
- oVPState
- The View Point state.
o Set3DState
| public virtual Set3DState( | const | ib3DState) |
-
Sets the 3D State : display or not the capture.
- Parameters:
-
- i3DState
- The new 3D State.
o SetActiveView
| public virtual SetActiveView( | const | ipiActiveView) |
-
Sets the active view for the capture.
- Parameters:
-
- ipiActiveView
- The new View.
o SetActiveViewState
| public virtual SetActiveViewState( | const | iActiveState) |
-
Sets the Active View state, saved or Not.
- Parameters:
-
- iActiveState
- The new Active View state.
o SetCamera
| public virtual SetCamera( | const | ipiCamera) |
-
Sets the Camera that stores the viewpoint of the Capture.
- Parameters:
-
- ipiCamera
- The Camera.
o SetClippingPlane
| public virtual SetClippingPlane( | const | iClipPlane) |
-
Sets the clipping plane state, activated or Not.
- Parameters:
-
- iClipPlane
- The new Clipping plane state.
o SetConstructedGeometry
| public virtual SetConstructedGeometry( | const | ipiList) |
-
Sets the Constructed Geometries that are visualy managed by this Capture.
- Parameters:
-
- ipiList
- List of managed TPSs.
o SetCurrent
| public virtual SetCurrent( | const | iCurrentState) |
-
Sets the Capture state, current or Not.
- Parameters:
-
- iCurrentState
- The new Capture state.
o SetHiddenText
| public virtual SetHiddenText( | const | ipText) |
-
Sets the Hidden Text.
- Parameters:
-
- ipText
- The Hidden Text.
o SetManageHideShowBody
| public virtual SetManageHideShowBody( | | ibManageHideShowBody) |
-
Sets the Setting Whether Part and Body Hide & Show
that are visually managed by this Capture.
- Parameters:
-
- ibManageHideShowBody
- TRUE If Hide & Show of Body to be Managed
FALSE If Hide & Show of Body is not to be Managed
o SetPartInstAndBody
| public virtual SetPartInstAndBody( | const | ipiList) |
-
Sets the Part Instances & Geometrical Feature Set
that are visually managed by this Capture.
- Parameters:
-
- opiList
- List of managed PartInstance & Geometrical Feature Set.
o SetTPSViews
| public virtual SetTPSViews( | const | ipiList) |
-
Sets the TPS Views that are visualy managed by this Capture.
- Parameters:
-
- ipiList
- List of managed Views.
o SetTPSs
| public virtual SetTPSs( | const | ipiList) |
-
Sets the TPSs that are visualy managed by this Capture.
- Parameters:
-
- ipiList
- List of managed TPSs.
o SetViewPoint
| public virtual SetViewPoint( | const | iVPState) |
-
Sets the ViewPoint state, saved or Not.
- Parameters:
-
- iVPState
- The new View Point state.
This object is included in the file: CATITPSCapture.h
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.