All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ConstraintModelerInterfaces Interface CATIDimCst2

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIDimCst2
 

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


interface CATIDimCst2

Interface to manage constraints and parameters visualization.
Role: This interface unifies behaviors of constraints and features' parameters for visualization purpose.


Method Index


o GetCalloutPositionForDimension3d(double*,double*)
Gets the callout anchor point and the normal to dimension plane.
o GetDisplayMode(DisplayMode&)
Gets the display mode of the constraint.
o SetCalloutPositionForDimension3d(double*)
Sets the callout position for 3D dimension.
o SetDisplayMode(DisplayMode)
Sets the display mode of the constraint.

Enumerated Type Index


o DisplayMode
Constraint display mode.

Methods


o GetCalloutPositionForDimension3d
public virtual HRESULT GetCalloutPositionForDimension3d(double* oCallout,
double* oNorm)const = 0
Gets the callout anchor point and the normal to dimension plane. (Necessary to create a 3D manipulator). Allows users to get the position of the constraint.
Parameters:
oCallout
coordinates of the callout in an array of 3 doubles.
oNorm
coordinates of the normal to dimension plane in an array of 3 doubles.
Returns:
S_OK
on success
E_FAIL
on failure
o GetDisplayMode
public virtual HRESULT GetDisplayMode(DisplayMode& oDisplayMode)const = 0
Gets the display mode of the constraint.
Parameters:
oDisplayMode
Legal values:
DisplayValue : The text of the constraint is displayed as its value.
DisplayName : The text of the constraint is displayed as its name.
DisplayNameAndValue : The text of the constraint is displayed as its name = value.
DisplayNameAndValueAndFormula : The text of the constraint is displayed as its name = value - formula.
Returns:
S_OK
on success
E_FAIL
on failure
o SetCalloutPositionForDimension3d
public virtual HRESULT SetCalloutPositionForDimension3d(double* iCallout)const = 0
Sets the callout position for 3D dimension. Throws GeometricalException. Allows users to choose a position for the constraint.
Parameters:
iCallout
coordinates of the callout as an array of 3 doubles.
Returns:
S_OK
on success
E_FAIL
on failure
o SetDisplayMode
public virtual HRESULT SetDisplayMode( const DisplayMode iDisplayMode) = 0
Sets the display mode of the constraint.
Parameters:
iDisplayMode
Legal values:
DisplayValue : The text of the constraint is displayed as its value.
DisplayName : The text of the constraint is displayed as its name.
DisplayNameAndValue : The text of the constraint is displayed as its name = value.
DisplayNameAndValueAndFormula : The text of the constraint is displayed as its name = value - formula.
Returns:
S_OK
on success
E_FAIL
on failure

Enumerated Types


o DisplayMode
enum DisplayMode {
  DisplayValue,
  DisplayName,
  DisplayNameAndValue,
  DisplayNameAndValueAndFormula
}
Constraint display mode. The mode is used as input parameter in
SetDisplayMode and as output parameter in GetDisplayMode
Parameters:
DisplayValue
The text of the constraint is displayed as its value.
DisplayName
The text of the constraint is displayed as its name.
DisplayNameAndValue
The text of the constraint is displayed as its name = value.
DisplayNameAndValueAndFormula
The text of the constraint is displayed as its name = value - formula.

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

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