All Frameworks  Class Hierarchy  This Framework  Indexes

AnalysisMeshingToolsItf Class CATMSHCustomHighlight

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---DialogEngine.CATAcquisitionFilter
        |
        +---CATMSHCustomHighlight
 

Usage: you must use this class as is. You should never derive it.


public class CATMSHCustomHighlight

Interface representing a pre-highlight and highlight of a finite element entity.
Role: This interface provides a customization of the highlight behavoiur on : element, node, finite element's edge, finite element's face.


Constructor and Destructor Index


o CATMSHCustomHighlight(CATMSHMethodHilight,void*)
Creates an object which defines custom hiligth method an associated data.

Method Index


o HighlightEdge(CAT3DCustomRep*,CATMSHElement*,int)
Defines the default hiligth behaviour for the edge of finite element.
o HighlightElement(CAT3DCustomRep*,CATMSHElement*)
Defines the default hiligth behaviour of finite element.
o HighlightFace(CAT3DCustomRep*,CATMSHElement*,int)
Defines the default hiligth behaviour for the face of finite element.
o HighlightNode(CAT3DCustomRep*,CATMSHNode*)
Defines the default hiligth behaviour for a node.

Constructor and Destructor


o CATMSHCustomHighlight
public CATMSHCustomHighlight(CATMSHMethodHilight iMethod= NULL ,
void* iHData= NULL )
Creates an object which defines custom hiligth method an associated data.
Role: This object creates a link to the custimzed method which should be called to highlight a FEM entity.
Parameters:
iMethod
The customized service to call in the hiligth. The parameters of this service are defined by the typedef described below.
iHData
The data associated to the customized implementation of highlight.

Methods


o HighlightEdge
public static HRESULT HighlightEdge(CAT3DCustomRep* iRep,
CATMSHElement* Element,
int iEdge)
Defines the default hiligth behaviour for the edge of finite element.
Parameters:
iRep
The rep associated to the hiligth of a edge of finite element.
iElement
The finite element object whose the edge is to hiligth.
iEdge
The finite element edge number to hiligth.
Returns:
An HRESULT.
Legal values:
S_OK
The hiligth is succesfull.
E_FAIL
The hiligth failed.
o HighlightElement
public static HRESULT HighlightElement(CAT3DCustomRep* iRep,
CATMSHElement* iElement)
Defines the default hiligth behaviour of finite element.
Parameters:
iRep
The rep associated to element for hiligth.
iElement
The finite element object to hiligth.
Returns:
An HRESULT.
Legal values:
S_OK
The hiligth is succesfull.
E_FAIL
The hiligth failed.
o HighlightFace
public static HRESULT HighlightFace(CAT3DCustomRep* iRep,
CATMSHElement* Element,
int iFace)
Defines the default hiligth behaviour for the face of finite element.
Parameters:
iRep
The rep associated to the hiligth of a face of finite element.
iElement
The finite element object whose the face is to hiligth.
iFace
The finite element face number to hiligth.
Returns:
An HRESULT.
Legal values:
S_OK
The hiligth is succesfull.
E_FAIL
The hiligth failed.
o HighlightNode
public static HRESULT HighlightNode(CAT3DCustomRep* iRep,
CATMSHNode* iNode)
Defines the default hiligth behaviour for a node.
Parameters:
iRep
The rep associated to the hiligth of a edge of finite element.
iNode
The finite element node object to hiligth.
Returns:
An HRESULT.
Legal values:
S_OK
The hiligth is succesfull.
E_FAIL
The hiligth failed.

This object is included in the file: CATMSHCustomHighlight.h
If needed, your Imakefile.mk should include the module: CATAmtToolsItf

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