Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDftDimensionLineForeshortened

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

interface CATIDftDimensionLineForeshortened

Manages the forshortened dimension line.

Method Index

o GetBeginingPoint(CATMathPoint2D&): Gets the starting point of the forshorten line, (begining point of foreshortened first segment).
o GetFShortAngle(double&): Gets dimension line angle.
o GetMoveBehavior(CATAnnDimMoveBehavior&): Sets the behavior of starting point of the forshortened line when the dimension moves.
o GetSegmentOrientationMode(CATAnnDimSegmentOrientationMode&): Gets segment orientation mode.
o GetSegmentRatio(double&): Gets the segment ratio.
o GetSymbolScale(double&): Gets the begining point symbol scale.
o GetValueLocationMode(CATAnnDimValueLocationMode&): Gets dimension value location mode.
o IsForeshorten(CATBoolean&): Returns whether or not a dimension line is foreshortened.
o SetBeginingPointReference(CATBaseUnknown*): Associate forshortened begining point to a Reference object .
o SetBeginingPointReferencePosition(CATMathPoint2D&): store user selected point for foreshortened begining point placement.
o SetFShortAngle(double): Sets dimension line angle.
o SetForeshorten(CATBoolean): Sets the foreshorten mode On or Off.
o SetMoveBehavior(CATAnnDimMoveBehavior): Sets the behavior of starting point of the forshorten line when the dimension moves.
o SetSegmentOrientationMode(CATAnnDimSegmentOrientationMode): Sets segment orientation mode.
o SetSegmentRatio(double): Sets segment ratio.
o SetSymbolScale(double): Sets the begining point symbol scale.
o SetValueLocationMode(CATAnnDimValueLocationMode): Sets dimension value location mode.

o CATAnnDimMoveBehavior: Tells if the beginig point position is on manual positioning or automatic positioning.
o CATAnnDimSegmentOrientationMode: Tells if the orientation mode is parallel or convergent.
o CATAnnDimValueLocationMode: Tells if we are on the first segment or the second segment.

Methods

o GetBeginingPoint

public virtual GetBeginingPoint( oBeginingPoint)

Gets the starting point of the forshorten line, (begining point of foreshortened first segment).

Parameters:

oBeginingPoint: Starting point.

Returns:

S_OK: if everything ran OK
E_UNEXPECTED: if an unexpected error occured.
E_FAIL: if Begining Point is not defined

o GetFShortAngle

public virtual GetFShortAngle( oAngle)

Gets dimension line angle. The value is the angle between the first segment ant the middle one.

Parameters:

oAngle: returned Angle value.

Returns:

S_OK: if everything ran ok and Angle is retrived
E_UNEXPECTED: if an unexpected error occured.

o GetMoveBehavior

public virtual GetMoveBehavior( oBehavior)

Sets the behavior of starting point of the forshortened line when the dimension moves.

See also:

Parameters:

oBehavior: retrived behavior.

Returns:

S_OK: if everything ran OK
E_FAIL: if data model are corrupted
E_UNEXPECTED: if an unexpected error occured.

o GetSegmentOrientationMode

public virtual GetSegmentOrientationMode( oSegmentOrientation)

Gets segment orientation mode. This method manages the second segment orientation.

Parameters:

oSegmentOrientation

returned Segment Orientation.
Legal values are

Parallel Second segment is parallel to the first one.
Convergent Second segment converges to the circle center.

Returns:

S_OK: if everything ran OK
E_FAIL: if data model are corrupted
E_UNEXPECTED: if an unexpected error occured.

o GetSegmentRatio

public virtual GetSegmentRatio( oSegmentRatio)

Gets the segment ratio. The ratio is defined as follow :
(first segment length) / (second segment length).

Parameters:

oSegmentRatio: returned Segment Ratio value.

Returns:

S_OK: if everything ran ok and Segment Ratio value is retrived
E_UNEXPECTED: if an unexpected error occured.

o GetSymbolScale

public virtual GetSymbolScale( oSymbolScale)

Gets the begining point symbol scale.

Parameters:

oSymbolScale: returned Symbol Scale value.

Returns:

S_OK: if everything ran ok and Symbol Scale is retrived
E_UNEXPECTED: if an unexpected error occured.

o GetValueLocationMode

public virtual GetValueLocationMode( oLocationMode)

Gets dimension value location mode. The forshortened dimension line is made of 3 segments:

the one which is near the circle center is called the first segment.
the one which is near the circle arc is called the second segment.
the one in the middle is not named.

Parameters:

oLocationMode

returned Location Mode. Dimension value location mode legal values are :

CATAnnDimFirstSegment located on first dimension line segment.
CATAnnDimSecondSegment located on second dimension line segment.

Returns:

S_OK: if everything ran OK
E_UNEXPECTED: if an unexpected error occured.
E_FAIL: if data model are corrupted

o IsForeshorten

public virtual IsForeshorten( oIsFShort)

Returns whether or not a dimension line is foreshortened.

Parameters:

oIsFShort

oIsFShort legal values are:

TRUE: if the dimension line is foreshortened.
FALSE: if not.

Returns:

S_OK: if everything ran ok.
E_UNEXPECTED: if an unexpected error occured.

o SetBeginingPointReference

public virtual SetBeginingPointReference( ipiReference)

Associate forshortened begining point to a Reference object .

Parameters:

ipReference: element to be associeted to foreshotened, this element should be a geometry type line 2d.

Returns:

S_OK: if reference is correctly stored
E_UNEXPECTED: if an unexpected error occured.
E_INVALIDARG: Parameters are invalid

o SetBeginingPointReferencePosition

public virtual SetBeginingPointReferencePosition( const iSelectedPoint)

store user selected point for foreshortened begining point placement. this point is used to compute the begining point position.

Parameters:

iSelectedPoint: selected point.

Returns:

S_OK: if everything ran ok and point is stored
E_UNEXPECTED: if an unexpected error occured.

o SetFShortAngle

public virtual SetFShortAngle( iAngle)

Sets dimension line angle.

See also:

Parameters:

iAngle: Angle.

Returns:

S_OK: if everything ran OK
E_UNEXPECTED: if an unexpected error occured.
E_INVALIDARG: Parameters are invalid (see preconditions).

o SetForeshorten

public virtual SetForeshorten( imode)

Sets the foreshorten mode On or Off.

Parameters:

imode

Mode On or Off.
Mode legal values are:

TRUE: the dimension line is foreshortened.
FALSE: the dimension line is not foreshortened.

Returns:

S_OK: if everything ran ok.
E_UNEXPECTED: if an unexpected error occured.

o SetMoveBehavior

public virtual SetMoveBehavior( iBehavior)

Sets the behavior of starting point of the forshorten line when the dimension moves. Move behavior legal value are:

CATAnnDimAuto begining point is computed automatically.
CATAnnDimManual begining point is controlled manuelly bye user.

Parameters:

iBehavior: behavior.

Returns:

S_OK: if everything ran OK
E_UNEXPECTED: if an unexpected error occured.
E_INVALIDARG: Parameters are invalid

o SetSegmentOrientationMode

public virtual SetSegmentOrientationMode( iOrientationMode)

Sets segment orientation mode.

See also:

Parameters:

iOrientationMode: Orientation mode.

Returns:

S_OK: if everything ran OK
E_UNEXPECTED: if an unexpected error occured.
E_INVALIDARG: Parameters are invalid

o SetSegmentRatio

public virtual SetSegmentRatio( iSegmentRatio)

Sets segment ratio.

See also:

Parameters:

iSegmentRatio: Ratio.

Returns:

S_OK: if everything ran OK
E_UNEXPECTED: if an unexpected error occured.
E_INVALIDARG: Parameters are invalid (see preconditions).

o SetSymbolScale

public virtual SetSymbolScale( iSymbolScale)

Sets the begining point symbol scale.

Parameters:

iSymbolScale: Symbol Scale.

Returns:

S_OK: if everything ran OK
E_UNEXPECTED: if an unexpected error occured.

o SetValueLocationMode

public virtual SetValueLocationMode( iLocationMode)

Sets dimension value location mode.

See also:

Parameters:

iLocationMode: Location Mode.

Returns:

S_OK: if everything ran OK
E_UNEXPECTED: if an unexpected error occured.
E_INVALIDARG: Parameters are invalid

Enumerated Types

o CATAnnDimMoveBehavior

enum CATAnnDimMoveBehavior {
  CATAnnDimAuto,
  CATAnnDimManual
}

Tells if the beginig point position is on manual positioning or automatic positioning.

Parameters:

CATAnnDimAuto: ForeShortened begining point is computed automatically.
CATAnnDimManual: ForeShortened begining point is controlled manuelly bye user.

o CATAnnDimSegmentOrientationMode

enum CATAnnDimSegmentOrientationMode {
  CATAnnDimParallel,
  CATAnnDimConvergent
}

Tells if the orientation mode is parallel or convergent.

Parameters:

CATAnnDimParallel: The ForeShortened Second segment dimension is parallel to the first one.
CATAnnDimParallel: The ForeShortened Second segment dimension converges to the circle center.

o CATAnnDimValueLocationMode

enum CATAnnDimValueLocationMode {
  CATAnnDimFirstSegment,
  CATAnnDimSecondSegment
}

Tells if we are on the first segment or the second segment.

Parameters:

CATAnnDimFirstSegment: forshortened dimension line which is near the circle center, it is called the first segment.
CATAnnDimSecondSegment: forshortened dimension line which is near the circle arc, it is called the second segment.

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

CATAnnotationUseItf Interface CATIDftDimensionLineForeshortened

Method Index

Enumerated Type Index

Methods

Enumerated Types