All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchRouteAlternateGraphic
System.IUnknown
|
+---CATISchRouteAlternateGraphic
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchRouteAlternateGraphic
Interface to manage Schematic component's association with its
alternate graphic representation objects.
Role: To modify component's links to its
alternate graphical representations.
Method Index
- o
AddAlternateGraphic(double*,CATISchGRR**)
- Add an alternate graphical primitive to a route.
- o
ListAlternateGraphics(CATIUnknownList**)
- Lists the alternate graphics of a route.
- o
RemoveAllAlternateGraphics()
- Removes all alternate graphical primitives.
- o
RemoveAllAlternateGraphicsOfStyle(CATSchRouteAlternateGraphicStyle&)
- Removes all alternate graphical primitives of the given style.
- o
RemoveAlternateGraphic(CATISchGRR*)
- Remove an alternate graphical primitive from a route.
Methods
o AddAlternateGraphic
public virtual HRESULT AddAlternateGraphic( | const double* | iInitialXYPosition, |
| CATISchGRR** | oAddedGRR)= 0 |
-
Add an alternate graphical primitive to a route.
The alternate graphical style is determined by the application.
The @see CATISchAppRouteAlternateGraphic interface must be implemented
on the Schematic component in order to specify the graphic style.
The @see CATISchAppAssembly interface must also be implemented on
on the Schematic component in order to identify the component as an
assembly.
- Parameters:
-
- iInitialXYPosition
- The initial position for calculating the display of the graphic.
If NULL, the start point will be calculated based on the route
graphic path of the first assembly member to this Schematic component.
- oAddedGRR
- The route alternate graphical primitive that is added to the route.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListAlternateGraphics
-
Lists the alternate graphics of a route. The list contains all
objects of the same alternate graphic style. The style is determined
by the appliction. The @see CATISchAppRouteAlternateGraphic interface
must be implemented on the Schematic component in order to specify the
graphic style.
- Parameters:
-
- oLGRR
- A list of the alternate graphic objects.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RemoveAllAlternateGraphics
public virtual HRESULT RemoveAllAlternateGraphics( | )= 0 |
-
Removes all alternate graphical primitives.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RemoveAllAlternateGraphicsOfStyle
-
Removes all alternate graphical primitives of the given style.
- Parameters:
-
- iStyle
- An enum of the style of alternate graphic to remove.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RemoveAlternateGraphic
-
Remove an alternate graphical primitive from a route.
- Parameters:
-
- iGRRToBeRemoved
- The route alternate graphic to be removed from the route. The input
graphic will be removed as long as there are at least two alternate
graphics of that style on the route.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchRouteAlternateGraphic.h