All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSOInterfaces Interface CATIGSMUnfold

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

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


interface CATIGSMUnfold

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

See also:
CATIGSOFactory.CreateUnfold


Method Index


o AppendElementsToTear(CATISpecObject_var&)
Append a specification to tear.
o AppendElementsToTear(CATListValCATISpecObject_var&)
Append specifications to tear.
o AppendElementsToTransfer(CATISpecObject_var&,CATGSMTypeOfTransfer)
Appends an element to transfer.
o GetDirectionToUnfold(CATISpecObject_var&)
Get the direction of the surface to unfold.
o GetEdgeToTearPositioningOrientation(CATGSMUnfoldEdgeToTearPositioning&)
Gets the positioning orientation when the reference origin is located on an edge to tear.
o GetElementsToTear(CATListValCATISpecObject_var&)
Gets the specifications to tear.
o GetOriginToUnfold(CATISpecObject_var&)
Gets the origin of the surface to unfold.
o GetSurfaceToUnfold(CATISpecObject_var&)
Gets the surface to unfold.
o GetSurfaceType(CATGSMUnfoldSurfaceType&)
Gets the type of surface to unfold.
o GetTargetDirection(CATIGSMDirection_var&)
Gets the plane where to unfold.
o GetTargetOrientationMode(CATGSMUnfoldTargetOrientationMode&)
Gets the target surface orientation mode.
o GetTargetOrigin(CATISpecObject_var&)
Gets the plane where to unfold.
o GetTargetSurface(CATISpecObject_var&)
Gets the plane where to unfold.
o GetTransferedElements(CATListValCATISpecObject_var&)
Gets the transfered elements.
o RemoveAllElementsToTear()
Removes all the specification to tear.
o RemoveElementToTear(CATISpecObject_var&)
Removes a specification to tear.
o RemoveElementToTear(CATLONG32)
Removes a specification to tear.
o RemoveElementToTransfer(CATLONG32)
Remove an elements to transfer.
o ReplaceElementsToTear(CATLONG32,CATISpecObject_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,CATISpecObject_var&)
Replace an elements to transfer.
o SetDirectionToUnfold(CATISpecObject_var&)
Set the direction of the surface to unfold.
o SetEdgeToTearPositioningOrientation(CATGSMUnfoldEdgeToTearPositioning)
Sets the positioning orientation when the reference origin is located on an edge to tear.
o SetOriginToUnfold(CATISpecObject_var&)
Set the origin of the surface to unfold.
o SetSurfaceToUnfold(CATISpecObject_var&)
Set the surface to unfold.
o SetSurfaceType(CATGSMUnfoldSurfaceType)
Sets the type of surface to unfold.
o SetTargetDirection(CATIGSMDirection_var&)
Set the the plane where to unfold.
o SetTargetOrientationMode(CATGSMUnfoldTargetOrientationMode)
Sets the target surface orientation mode.
o SetTargetOrigin(CATISpecObject_var&)
Set the the plane where to unfold.
o SetTargetSurface(CATISpecObject_var&)
Set the the plane where to unfold.

Methods


o AppendElementsToTear
public virtual HRESULT AppendElementsToTear( const CATISpecObject_var& ihSpecObject)=0
Append a specification to tear.
Parameters:
ihSpecObject
the specification to tear to append.
o AppendElementsToTear
public virtual HRESULT AppendElementsToTear( const CATListValCATISpecObject_var& iSpecObjectsList)=0
Append specifications to tear.
Parameters:
iSpecObjectsList
the specifications to tear to append.
o AppendElementsToTransfer
public virtual HRESULT AppendElementsToTransfer( const CATISpecObject_var& ihSpecObject,
CATGSMTypeOfTransfer iTypeOfTransfer)=0
Appends an element to transfer.
Parameters:
ihSpecObject
Specification to transfer
iTypeOfTransfer
type of tranfer
See also:
CATGSMTypeOfTransfer
o GetDirectionToUnfold
public virtual HRESULT GetDirectionToUnfold(CATISpecObject_var& ohSpecObject)=0
Get the direction of the surface to unfold.
Parameters:
ohSpecObject
the direction
o GetEdgeToTearPositioningOrientation
public virtual HRESULT GetEdgeToTearPositioningOrientation(CATGSMUnfoldEdgeToTearPositioning& oOrientation)=0
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 HRESULT GetElementsToTear(CATListValCATISpecObject_var& oSpecObjectsList)=0
Gets the specifications to tear.
Parameters:
oSpecObjectsList
the specifications to tear.
o GetOriginToUnfold
public virtual HRESULT GetOriginToUnfold(CATISpecObject_var& ohSpecObject)=0
Gets the origin of the surface to unfold.
Parameters:
ohSpecObject
the origin of the surface to unfold.
o GetSurfaceToUnfold
public virtual HRESULT GetSurfaceToUnfold(CATISpecObject_var& ohSpecObject)=0
Gets the surface to unfold.
Parameters:
ohSpecObject
the surface to unfold.
o GetSurfaceType
public virtual HRESULT GetSurfaceType(CATGSMUnfoldSurfaceType& oType)=0
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:
CATGSMUnfoldSurfaceType
o GetTargetDirection
public virtual HRESULT GetTargetDirection(CATIGSMDirection_var& ohDirection)=0
Gets the plane where to unfold.
Parameters:
ohSpecObject
the plane where to unfold.
o GetTargetOrientationMode
public virtual HRESULT GetTargetOrientationMode(CATGSMUnfoldTargetOrientationMode& oMode)=0
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:
CATGSMUnfoldTargetOrientationMode
o GetTargetOrigin
public virtual HRESULT GetTargetOrigin(CATISpecObject_var& ohSpecObject)=0
Gets the plane where to unfold.
Parameters:
ohSpecObject
the plane where to unfold.
o GetTargetSurface
public virtual HRESULT GetTargetSurface(CATISpecObject_var& ohSpecObject)=0
Gets the plane where to unfold.
Parameters:
ohSpecObject
the plane where to unfold.
o GetTransferedElements
public virtual HRESULT GetTransferedElements(CATListValCATISpecObject_var& oSpecObjectsList) =0
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 HRESULT RemoveAllElementsToTear()=0
Removes all the specification to tear.
o RemoveElementToTear
public virtual HRESULT RemoveElementToTear(CATISpecObject_var& ihSpecObject)=0
Removes a specification to tear.
Parameters:
ihSpecObject
the specification to remove.
o RemoveElementToTear
public virtual HRESULT RemoveElementToTear( const CATLONG32 i)=0
Removes a specification to tear.
Parameters:
i
the position of the specifications to tear to remove.
o RemoveElementToTransfer
public virtual HRESULT RemoveElementToTransfer( const CATLONG32 i)=0
Remove an elements to transfer.
Parameters:
i
the position of the specification to remove
o ReplaceElementsToTear
public virtual HRESULT ReplaceElementsToTear( const CATLONG32 i,
const CATISpecObject_var& ihSpecObject)=0
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 HRESULT ReplaceElementsToTransfer( const CATLONG32 i,
CATGSMTypeOfTransfer iTypeOfTransfer)=0
Replace a type of transfer.
Parameters:
i
the position of the specification type to replace
iTypeOfTransfer
type of tranfer
See also:
CATGSMTypeOfTransfer
o ReplaceElementsToTransfer
public virtual HRESULT ReplaceElementsToTransfer( const CATLONG32 i,
const CATISpecObject_var& ihSpecObject)=0
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 HRESULT SetDirectionToUnfold( const CATISpecObject_var& ihSpecObject)=0
Set the direction of the surface to unfold.
Parameters:
ihSpecObject
the direction
o SetEdgeToTearPositioningOrientation
public virtual HRESULT SetEdgeToTearPositioningOrientation( const CATGSMUnfoldEdgeToTearPositioning iOrientation)=0
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 HRESULT SetOriginToUnfold( const CATISpecObject_var& ihSpecObject)=0
Set the origin of the surface to unfold.
Parameters:
ihSpecObject
the origin
o SetSurfaceToUnfold
public virtual HRESULT SetSurfaceToUnfold( const CATISpecObject_var& ihSpecObject)=0
Set the surface to unfold.
Parameters:
ihSpecObject
the surface to unfold.
o SetSurfaceType
public virtual HRESULT SetSurfaceType( const CATGSMUnfoldSurfaceType iType)=0
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:
CATGSMUnfoldSurfaceType
o SetTargetDirection
public virtual HRESULT SetTargetDirection( const CATIGSMDirection_var& ihDirection)=0
Set the the plane where to unfold.
Parameters:
ihSpecObject
the plane where to unfold.
o SetTargetOrientationMode
public virtual HRESULT SetTargetOrientationMode( const CATGSMUnfoldTargetOrientationMode iMode)=0
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:
CATGSMUnfoldTargetOrientationMode
o SetTargetOrigin
public virtual HRESULT SetTargetOrigin( const CATISpecObject_var& ihSpecObject)=0
Set the the plane where to unfold.
Parameters:
ihSpecObject
the plane where to unfold.
o SetTargetSurface
public virtual HRESULT SetTargetSurface( const CATISpecObject_var& ihSpecObject)=0
Set the the plane where to unfold.
Parameters:
ihSpecObject
the plane where to unfold.

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

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