All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchDisplay

System.IUnknown
  |
  +---CATISchDisplay
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISchDisplay

Interface to manage the "look" of a graphic representation of Schematic basic set of objects.
Role: To modify the visualization attributes such as highlight and show-hide


Method Index


o BuildHighlightLook(CATPathElement&,CATRepPath&)
Get the display of the graphic representation.
o BuildRep(CATRep**)
Get the display of the graphic representation.
o GetBoundingBox(double*)
Get the bounding box of the graphic representation.
o GetColor(CATISchGRR*,int*,int*,int*)
Get the color of the graphic representation of objects.
o GetLineType(CATISchGRR*,int*)
Get the line type of the graphic representation of objects.
o GetThickness(CATISchGRR*,int*)
Get the line thickness of the graphic representation of objects.
o Highlight(CATBoolean)
Highlight or de-highlight an object's graphic representation.
o SetColor(int,int,int,CATISchGRR*)
Set the color of the graphic representation of objects.
o SetLineType(int,CATISchGRR*)
Set the line type of the graphic representation of objects.
o SetThickness(int,CATISchGRR*)
Set the line thickness of the graphic representation of objects.
o Show(CATBoolean)
Show or hide an object's graphic representation.

Methods


o BuildHighlightLook
public virtual HRESULT BuildHighlightLook( const CATPathElement& iModelPath,
CATRepPath& oRepPath) = 0
Get the display of the graphic representation.
See also:
CATI2DGeoVisu.BuildHighlightLook
Parameters:
iModelPath
CATPathElement of the selected object
oRepPath
CATRepPath of the selected object
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o BuildRep
public virtual HRESULT BuildRep(CATRep** oRep) = 0
Get the display of the graphic representation.
See also:
CATI2DGeoVisu.BuildRep
Parameters:
oRep
pointer to CATRep of the display.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetBoundingBox
public virtual HRESULT GetBoundingBox(double* oDb4BoxCorner) = 0
Get the bounding box of the graphic representation.
Parameters:
oDb4BoxCorner
An array of 4 doubles. member 1-2 is the X-Y coordinates of the lower left corner point of the bounding box. member 3-4 is the X-Y coordinates of the upper right corner point of the bounding box.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetColor
public virtual HRESULT GetColor(CATISchGRR* iGRR,
int* oRed,
int* oGreen,
int* oBlue) = 0
Get the color of the graphic representation of objects.
Parameters:
iGRR
The specific graphic image to get the graphic properties from. If NULL, the first image associated with the object will be used.
oRed
Red component of color
oGreen
Green component of color
oBlue
Blue component of color
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetLineType
public virtual HRESULT GetLineType(CATISchGRR* iGRR,
int* oLineType) = 0
Get the line type of the graphic representation of objects.
Parameters:
iGRR
The specific graphic image to get the graphic properties from. If NULL, the first image associated with the object will be used.
oLinetype
The line type.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetThickness
public virtual HRESULT GetThickness(CATISchGRR* iGRR,
int* oThichness) = 0
Get the line thickness of the graphic representation of objects.
Parameters:
iGRR
The specific graphic image to get the graphic properties from. If NULL, the first image associated with the object will be used.
oThickness
The thickness index.
o Highlight
public virtual HRESULT Highlight(CATBoolean iBOn) = 0
Highlight or de-highlight an object's graphic representation.
Parameters:
iBOn
if TRUE, highlight. Else de-highlight.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetColor
public virtual HRESULT SetColor(int iRed,
int iGreen,
int iBlue,
CATISchGRR* iGRR=NULL) = 0
Set the color of the graphic representation of objects.
Parameters:
iRed
The red component of the color. Legal values: iRed ranges from 0 to 255.
iGreen
The green component of the color. Legal values: iGreen ranges from 0 to 255.
iBlue
The blue component of the color. Legal values: iBlue ranges from 0 to 255.
iGRR
The specific graphic image to change graphic properties. If NULL, all the images associated with the object will be changed.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetLineType
public virtual HRESULT SetLineType(int iLinetype,
CATISchGRR* iGRR=NULL) = 0
Set the line type of the graphic representation of objects.
Parameters:
iLinetype
The line type. Legal values: iLinetype ranges from 1 to 63.
  • 1 = Solid.
  • 2 = Dotted.
  • 3 = Dashed.
  • 4 = Dot-dashed.
  • 5 = Phantom.
  • 6 = Small-dotted.
  • 7 = JIS Axis.
  • 8 to 63 = Solid or application dependant.
iGRR
The specific graphic image to change graphic properties. If NULL, all the images associated with the object will be changed.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetThickness
public virtual HRESULT SetThickness(int iThickness,
CATISchGRR* iGRR=NULL) = 0
Set the line thickness of the graphic representation of objects.
Parameters:
iThickness
The thickness index. Legal values: iThickness range from 1 to 16.
o Show
public virtual HRESULT Show(CATBoolean iBOn) = 0
Show or hide an object's graphic representation.
Parameters:
iBOn
if TRUE, show the graphic representation. Else hide it.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchDisplay.h

Copyright © 2003, Dassault Systèmes. All rights reserved.