All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchRouteSymbol
System.IUnknown
|
+---CATISchRouteSymbol
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchRouteSymbol
Interface to manage a symbol placed on a route.
Role: Defines a route symbol object content.
Method Index
- o
FlipOverLine()
- Mirror the symbol over the route segment line on which
the symbol is positioned.
- o
FlipOverOrthogonalLine()
- Mirror the symbol over the line orthogonal to the route segment
line on which the symbol is positioned and going through the
symbol's position point on that segment line.
- o
GetGRRRoute(CATISchGRRRoute**)
- Get the graphical representation of a schematic route that owns this symbol.
- o
GetPosition(int&,double&)
- Get the symbol's position on the route that own it.
- o
Scale(double&)
- Scale the symbol.
- o
SetPosition(int&,double&)
- Set the symbol's position on the route that own it.
Methods
o FlipOverLine
public virtual HRESULT FlipOverLine( | )= 0 |
-
Mirror the symbol over the route segment line on which
the symbol is positioned.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o FlipOverOrthogonalLine
public virtual HRESULT FlipOverOrthogonalLine( | )= 0 |
-
Mirror the symbol over the line orthogonal to the route segment
line on which the symbol is positioned and going through the
symbol's position point on that segment line.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetGRRRoute
-
Get the graphical representation of a schematic route that owns this symbol.
- Parameters:
-
- oGRRRoute
- The graphical representation that owns this symbol.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetPosition
public virtual HRESULT GetPosition( | int& | oSegNum, |
| double& | oSegParm) = 0 |
-
Get the symbol's position on the route that own it.
- Parameters:
-
- oSegNum
- The route segment number.
- oSegParm
- The parameter along the segment (0.<=iSegParm<=1.).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Scale
public virtual HRESULT Scale( | const double& | iDbScaleFactor) = 0 |
-
Scale the symbol.
- Parameters:
-
- iDbScaleFactor
- The scale factor to scale the symbol by.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetPosition
public virtual HRESULT SetPosition( | const int& | iSegNum, |
| const double& | iSegParm) = 0 |
-
Set the symbol's position on the route that own it.
- Parameters:
-
- iSegNum
- The route segment number (<= number of segments in the route).
- iSegParm
- The parameter along the segment (0.<=iSegParm<=1.).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchRouteSymbol.h