Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSOUseItf Interface CATIGSMUseUnfold

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

interface CATIGSMUseUnfold

Interface to Unfold feature.
Role:Allows to access data of the Unfold feature.

See also:

Method Index

o AppendElementsToTear(CATIMmiMechanicalFeature_var&): Append a specification to tear.
o AppendElementsToTear(CATListValCATIMmiMechanicalFeature_var&): Append specifications to tear.
o AppendElementsToTransfer(CATIMmiMechanicalFeature_var&,CATGSMTypeOfTransfer): Appends an element to transfer.
o GetDirectionToUnfold(CATIMmiMechanicalFeature_var&): Get the direction of the surface to unfold.
o GetDisplayDistortionMode(CATBoolean&): Gets the display mode of the distortion on the feature.
o GetEdgeToTearPositioningOrientation(CATGSMUnfoldEdgeToTearPositioning&): Gets the positioning orientation when the reference origin is located on an edge to tear.
o GetElementsToTear(CATListValCATIMmiMechanicalFeature_var&): Gets the specifications to tear.
o GetOriginToUnfold(CATIMmiMechanicalFeature_var&): Gets the origin of the surface to unfold.
o GetSurfaceToUnfold(CATIMmiMechanicalFeature_var&): Gets the surface to unfold.
o GetSurfaceType(CATGSMUnfoldSurfaceType&): Gets the type of surface to unfold.
o GetTargetDirection(CATIGSMUseDirection_var&): Gets the plane where to unfold.
o GetTargetOrientationMode(CATGSMUnfoldTargetOrientationMode&): Gets the target surface orientation mode.
o GetTargetOrigin(CATIMmiMechanicalFeature_var&): Gets the plane where to unfold.
o GetTargetSurface(CATIMmiMechanicalFeature_var&): Gets the plane where to unfold.
o GetTransferedElements(CATListValCATIMmiMechanicalFeature_var&): Gets the transfered elements.
o RemoveAllElementsToTear(): Removes all the specification to tear.
o RemoveElementToTear(CATLONG32): Removes a specification to tear.
o RemoveElementToTear(CATIMmiMechanicalFeature_var&): Removes a specification to tear.
o RemoveElementToTransfer(CATLONG32): Remove an elements to transfer.
o ReplaceElementsToTear(CATLONG32,CATIMmiMechanicalFeature_var&): Replaces the specification at the position i in the list of specification to tear by ihSpecObject.
o ReplaceElementsToTransfer(CATLONG32,CATGSMTypeOfTransfer): Replace a type of transfer.
o ReplaceElementsToTransfer(CATLONG32,CATIMmiMechanicalFeature_var&): Replace an elements to transfer.
o SetDirectionToUnfold(CATIMmiMechanicalFeature_var&): Set the direction of the surface to unfold.
o SetDisplayDistortionMode(CATBoolean&): Sets the display mode of the distortion on the feature.
o SetEdgeToTearPositioningOrientation(CATGSMUnfoldEdgeToTearPositioning): Sets the positioning orientation when the reference origin is located on an edge to tear.
o SetOriginToUnfold(CATIMmiMechanicalFeature_var&): Set the origin of the surface to unfold.
o SetSurfaceToUnfold(CATIMmiMechanicalFeature_var&): Set the surface to unfold.
o SetSurfaceType(CATGSMUnfoldSurfaceType): Sets the type of surface to unfold.
o SetTargetDirection(CATIGSMUseDirection_var&): Set the the plane where to unfold.
o SetTargetOrientationMode(CATGSMUnfoldTargetOrientationMode): Sets the target surface orientation mode.
o SetTargetOrigin(CATIMmiMechanicalFeature_var&): Set the the plane where to unfold.
o SetTargetSurface(CATIMmiMechanicalFeature_var&): Set the the plane where to unfold.

Methods

o AppendElementsToTear

public virtual AppendElementsToTear( const ihSpecObject)

Append a specification to tear.

Parameters:

ihSpecObject: the specification to tear to append.

o AppendElementsToTear

public virtual AppendElementsToTear( const iSpecObjectsList)

Append specifications to tear.

Parameters:

iSpecObjectsList: the specifications to tear to append.

o AppendElementsToTransfer

public virtual AppendElementsToTransfer(	const	`ihSpecObject`,
		`iTypeOfTransfer`)

Appends an element to transfer.

Parameters:

ihSpecObject: Specification to transfer
iTypeOfTransfer: type of tranfer

See also:

o GetDirectionToUnfold

public virtual GetDirectionToUnfold( ohSpecObject)

Get the direction of the surface to unfold.

Parameters:

ohSpecObject: the direction

o GetDisplayDistortionMode

public virtual GetDisplayDistortionMode( obMode)

Gets the display mode of the distortion on the feature.

Parameters:

obMode: TRUE : distortions are displayed FALSE : distortions are not displayed

o GetEdgeToTearPositioningOrientation

public virtual GetEdgeToTearPositioningOrientation( oOrientation)

Gets the positioning orientation when the reference origin is located on an edge to tear.

Parameters:

iOrientation: CATGSMUnfoldEdgeToTearUndefinedOrientation if the reference origin is not located on an edge to tear CATGSMUnfoldEdgeToTearDefaultOrientation if it is the default orientation CATGSMUnfoldEdgeToTearInversedOrientation if it is the inverse of the default orientation

o GetElementsToTear

public virtual GetElementsToTear( oSpecObjectsList)

Gets the specifications to tear.

Parameters:

oSpecObjectsList: the specifications to tear.

o GetOriginToUnfold

public virtual GetOriginToUnfold( ohSpecObject)

Gets the origin of the surface to unfold.

Parameters:

ohSpecObject: the origin of the surface to unfold.

o GetSurfaceToUnfold

public virtual GetSurfaceToUnfold( ohSpecObject)

Gets the surface to unfold.

Parameters:

ohSpecObject: the surface to unfold.

o GetSurfaceType

public virtual GetSurfaceType( oType)

Gets the type of surface to unfold.

Parameters:

oType: CATGSMUndefinedSurfaceType if the type is undefined, CATGSMRuledSurfaceType if the type of surface is ruled, CATGSMAnySurfaceType if the type of surface is all

See also:

o GetTargetDirection

public virtual GetTargetDirection( ohDirection)

Gets the plane where to unfold.

Parameters:

ohSpecObject: the plane where to unfold.

o GetTargetOrientationMode

public virtual GetTargetOrientationMode( oMode)

Gets the target surface orientation mode.

Parameters:

oMode: CATGSMUnfoldTargetOrientationMode_None if no axis inversion CATGSMUnfoldTargetOrientationMode_ReverseU if U inversion axis CATGSMUnfoldTargetOrientationMode_ReverseV if V inversion axis CATGSMUnfoldTargetOrientationMode_ReverseUReverseV if U inversion axis and V inversion axis CATGSMUnfoldTargetOrientationMode_SwapReverseU if U inversion axis and swap U and V axis CATGSMUnfoldTargetOrientationMode_SwapReverseV if V inversion axis and swap U and V axis CATGSMUnfoldTargetOrientationMode_SwapReverseUReverseV if U inversion axis, V inversion axis and swap U and V axis CATGSMUnfoldTargetOrientationMode_Swap if swap U and V axis

See also:

o GetTargetOrigin

public virtual GetTargetOrigin( ohSpecObject)

Gets the plane where to unfold.

Parameters:

ohSpecObject: the plane where to unfold.

o GetTargetSurface

public virtual GetTargetSurface( ohSpecObject)

Gets the plane where to unfold.

Parameters:

ohSpecObject: the plane where to unfold.

o GetTransferedElements

public virtual GetTransferedElements( oSpecObjectsList)

Gets the transfered elements.
Note: It references its specification and its type of transformation.

Parameters:

oSpecObjectsList: List of Specifications to transfer

o RemoveAllElementsToTear

public virtual RemoveAllElementsToTear(

)

Removes all the specification to tear.

o RemoveElementToTear

public virtual RemoveElementToTear( const i)

Removes a specification to tear.

Parameters:

i: the position of the specifications to tear to remove.

o RemoveElementToTear

public virtual RemoveElementToTear( ihSpecObject)

Removes a specification to tear.

Parameters:

ihSpecObject: the specification to remove.

o RemoveElementToTransfer

public virtual RemoveElementToTransfer( const i)

Remove an elements to transfer.

Parameters:

i: the position of the specification to remove

o ReplaceElementsToTear

public virtual ReplaceElementsToTear(	const	`i`,
	const	`ihSpecObject`)

Replaces the specification at the position i in the list of specification to tear by ihSpecObject.

Parameters:

i: the position of the specifications to tear to remove.
iSpecObjectsList: the specification to tear to append.

o ReplaceElementsToTransfer

public virtual ReplaceElementsToTransfer(	const	`i`,
		`iTypeOfTransfer`)

Replace a type of transfer.

Parameters:

i: the position of the specification type to replace
iTypeOfTransfer: type of tranfer

See also:

o ReplaceElementsToTransfer

public virtual ReplaceElementsToTransfer(	const	`i`,
	const	`ihSpecObject`)

Replace an elements to transfer.

Parameters:

i: the position of the specification to replace
ihSpecObject: the specification to transfer to append.

o SetDirectionToUnfold

public virtual SetDirectionToUnfold( const ihSpecObject)

Set the direction of the surface to unfold.

Parameters:

ihSpecObject: the direction

o SetDisplayDistortionMode

public virtual SetDisplayDistortionMode( const ibMode)

Sets the display mode of the distortion on the feature.

Parameters:

ibMode: TRUE : distortions are displayed FALSE : distortions are not displayed

o SetEdgeToTearPositioningOrientation

public virtual SetEdgeToTearPositioningOrientation( const iOrientation)

Sets the positioning orientation when the reference origin is located on an edge to tear.

Parameters:

iOrientation: CATGSMUnfoldEdgeToTearUndefinedOrientation if the reference origin is not located on an edge to tear CATGSMUnfoldEdgeToTearDefaultOrientation if it is the default orientation CATGSMUnfoldEdgeToTearInversedOrientation if it is the inverse of the default orientation

o SetOriginToUnfold

public virtual SetOriginToUnfold( const ihSpecObject)

Set the origin of the surface to unfold.

Parameters:

ihSpecObject: the origin

o SetSurfaceToUnfold

public virtual SetSurfaceToUnfold( const ihSpecObject)

Set the surface to unfold.

Parameters:

ihSpecObject: the surface to unfold.

o SetSurfaceType

public virtual SetSurfaceType( const iType)

Sets the type of surface to unfold.

Parameters:

iType: CATGSMUndefinedSurfaceType if the type is undefined, CATGSMRuledSurfaceType if the type of surface is ruled, CATGSMAnySurfaceType if the type of surface is all

See also:

o SetTargetDirection

public virtual SetTargetDirection( const ihDirection)

Set the the plane where to unfold.

Parameters:

ihSpecObject: the plane where to unfold.

o SetTargetOrientationMode

public virtual SetTargetOrientationMode( const iMode)

Sets the target surface orientation mode.

Parameters:

iMode: CATGSMUnfoldTargetOrientationMode_None if no axis inversion CATGSMUnfoldTargetOrientationMode_ReverseU if U inversion axis CATGSMUnfoldTargetOrientationMode_ReverseV if V inversion axis CATGSMUnfoldTargetOrientationMode_ReverseUReverseV if U inversion axis and V inversion axis CATGSMUnfoldTargetOrientationMode_SwapReverseU if U inversion axis and swap U and V axis CATGSMUnfoldTargetOrientationMode_SwapReverseV if V inversion axis and swap U and V axis CATGSMUnfoldTargetOrientationMode_SwapReverseUReverseV if U inversion axis, V inversion axis and swap U and V axis CATGSMUnfoldTargetOrientationMode_Swap if swap U and V axis

See also:

o SetTargetOrigin

public virtual SetTargetOrigin( const ihSpecObject)

Set the the plane where to unfold.

Parameters:

ihSpecObject: the plane where to unfold.

o SetTargetSurface

public virtual SetTargetSurface( const ihSpecObject)

Set the the plane where to unfold.

Parameters:

ihSpecObject: the plane where to unfold.

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