All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

PartInterfaces Interface CATIPrism

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---PartInterfaces.CATIShape
        |
        +---CATIPrism
 

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


interface CATIPrism

Interface associated to the Pad and Pocket features.
Role: This interface allows users to manage the specifications of a Prism (Pad or Pocket). A Prism extrudes a profile along a specific direction. A Pad adds material, a Pocket removes material.

See also:
CATIPad, CATIPocket


Method Index


o GetAxis()
Returns the direction internal component.
o GetDirection()
Returns the extrusion direction.
o GetEndInit()
Returns the first limit limiting element.
o GetEndLimit()
Returns the internal first limit component.
o GetEndOffset()
Returns the first limit offset value.
o GetEndType()
Returns the first limit type.
o GetInnerSide()
Returns the closing side of the open profile.
o GetMergeThin(int&)
Returns the lateral relimitation status for a thin prism.
o GetNeutralFiber(int&)
Returns the neutral fiber status for a thin prism.
o GetProfile()
Returns the profile internal component.
o GetReferenceDir()
Returns the reference element which specifies the direction.
o GetStartInit()
Returns the second limit limiting element.
o GetStartLimit()
Returns the second limit internal component.
o GetStartOffset()
Returns the second limit offset value.
o GetStartType()
Returns the second limit type.
o GetSym()
Tests whether the symmetrical extension is set or not.
o GetThickThin1(CATICkeParm_var&)
Returns the parameter links to the first thickness of a thin prism.
o GetThickThin1(double&)
Returns the value of the first thickness of a thin prism.
o GetThickThin2(CATICkeParm_var&)
Returns the parameter links to the second thickness of a thin prism.
o GetThickThin2(double&)
Returns the value of the second thickness of a thin prism.
o GetThinCheck(int&)
Returns the thin status for a prism.
o IsDirectionReversed()
Tests whether the direction is opposite to the reference or not.
o ModifyDirection(CATISpecObject_var&)
Specifies an element as reference for the direction.
o ModifyDirection(CATMathDirection&)
Specifies a mathematical extrusion direction.
o ModifyEndInit(CATISpecObject_var&)
Sets the first limit limiting element in case the type is catUpToPlaneLimit or catUpToSurfaceLimit.
o ModifyEndOffset(double)
Sets the first limit offset value in case the type is catOffsetLimit.
o ModifyEndType(int)
Sets the first limit type.
o ModifyInnerSide(int)
When the profile is open, specifies which side of the profile will be used for closing.
o ModifyProfile(CATISpecObject_var&)
Sets a new element as profile.
o ModifyStartInit(CATISpecObject_var&)
Sets the first limit limiting element in case the type is catUpToPlaneLimit or catUpToSurfaceLimit.
o ModifyStartOffset(double)
Sets the second limit offset value in case the type is catOffsetLimit.
o ModifyStartType(int)
Sets the second limit type.
o ModifySym(int)
Sets the symmetrical extension property.
o ReverseDirection()
Reverses the specified direction.
o SetMergeThin(int)
Sets the lateral relimitation status for a thin prism.
o SetNeutralFiber(int)
Sets the neutral fiber status for a thin prism.
o SetThickThin1(double)
Sets the value of the first thickness of a thin prism.
o SetThickThin2(double)
Sets the value of the second thickness of a thin prism.
o SetThinCheck(int)
Sets the thin status for a prism.

Methods


o GetAxis
public virtual CATISpecObject_var GetAxis()= 0
Returns the direction internal component.
Returns:
The axis feature.
o GetDirection
public virtual CATMathDirection GetDirection()= 0
Returns the extrusion direction.
Returns:
The extrusion vector.
o GetEndInit
public virtual CATISpecObject_var GetEndInit()= 0
Returns the first limit limiting element.
Returns:
The element.
o GetEndLimit
public virtual CATISpecObject_var GetEndLimit()= 0
Returns the internal first limit component.
Returns:
The limit feature.
o GetEndOffset
public virtual double GetEndOffset()= 0
Returns the first limit offset value.
Returns:
The offset value.
o GetEndType
public virtual int GetEndType()= 0
Returns the first limit type.
Returns:
The type.
o GetInnerSide
public virtual int GetInnerSide()= 0
Returns the closing side of the open profile.
Returns:
The side flag.
o GetMergeThin
public virtual void GetMergeThin(int& oMergeThin) = 0
Returns the lateral relimitation status for a thin prism.
Returns:
= 0 no lateral relimitation = 1 lateral relimitation
o GetNeutralFiber
public virtual void GetNeutralFiber(int& oNeutralFiber) = 0
Returns the neutral fiber status for a thin prism.
Returns:
= 0 neutral fiber inactivated = 1 neutral fiber activated
o GetProfile
public virtual CATISpecObject_var GetProfile()= 0
Returns the profile internal component.
Returns:
The profile.
o GetReferenceDir
public virtual CATISpecObject_var GetReferenceDir()= 0
Returns the reference element which specifies the direction.
Returns:
The reference element.
o GetStartInit
public virtual CATISpecObject_var GetStartInit()= 0
Returns the second limit limiting element.
Returns:
The element.
o GetStartLimit
public virtual CATISpecObject_var GetStartLimit()= 0
Returns the second limit internal component.
Returns:
The limit feature.
o GetStartOffset
public virtual double GetStartOffset()= 0
Returns the second limit offset value.
Returns:
The offset value.
o GetStartType
public virtual int GetStartType()= 0
Returns the second limit type.
Returns:
The type.
o GetSym
public virtual int GetSym()= 0
Tests whether the symmetrical extension is set or not.
Returns:
The symmetry flag.
Legal values: 1 for symmetry, 0 otherwise.
o GetThickThin1
public virtual void GetThickThin1(CATICkeParm_var& oThickParm) = 0
Returns the parameter links to the first thickness of a thin prism.
Returns:
The parameter.
o GetThickThin1
public virtual void GetThickThin1(double& oThick) = 0
Returns the value of the first thickness of a thin prism.
Returns:
The value.
o GetThickThin2
public virtual void GetThickThin2(CATICkeParm_var& oThickParm) = 0
Returns the parameter links to the second thickness of a thin prism.
Returns:
The parameter.
o GetThickThin2
public virtual void GetThickThin2(double& oThick) = 0
Returns the value of the second thickness of a thin prism.
Returns:
The value.
o GetThinCheck
public virtual void GetThinCheck(int& oThinCheck)= 0
Returns the thin status for a prism.
Returns:
= 0 prism not thin = 1 prism thin
o IsDirectionReversed
public virtual int IsDirectionReversed()= 0
Tests whether the direction is opposite to the reference or not.
Returns:
0 if the direction is same, 1 if the direction has been reversed.
o ModifyDirection
public virtual void ModifyDirection( const CATISpecObject_var& ihDir) = 0
Specifies an element as reference for the direction.
Parameters:
ihDir
The reference element.
o ModifyDirection
public virtual void ModifyDirection( const CATMathDirection& iDir) = 0
Specifies a mathematical extrusion direction.
Parameters:
iDir
The direction vector.
o ModifyEndInit
public virtual void ModifyEndInit( const CATISpecObject_var& ihInit) = 0
Sets the first limit limiting element in case the type is catUpToPlaneLimit or catUpToSurfaceLimit.
Parameters:
ihInit
The limiting element.
For the catUpToPlaneLimit type, it must be a plane feature or a planar FSur feature (CATIMfFsur).
For the catUpToSurfaceLimit type, it must be a face feature.
If this face belongs to some surfacic geometry, it must be a FSur feature. Then the entire surface is used to limit the shape.
If it is a face of a volume, it must be a RSur feature (CATIMfRsur) which belongs to the body in which the limited feature is created. In this case the limiting surface is defined by a propagation on the surface of the body starting from the init face.
o ModifyEndOffset
public virtual void ModifyEndOffset(double iOffset) = 0
Sets the first limit offset value in case the type is catOffsetLimit.
Parameters:
iOffset
The offset value.
o ModifyEndType
public virtual void ModifyEndType(int iType) = 0
Sets the first limit type.
Parameters:
iType
The type.
Legal values: They are provided with the CatLimitMode enum.
See also:
CATIPrtSimpleLimit
o ModifyInnerSide
public virtual void ModifyInnerSide(int iSide) = 0
When the profile is open, specifies which side of the profile will be used for closing.
Parameters:
iSide
The side information.
To determine the closing side users must compute a three vectors axis at a point of the contour:
- the tangent to the contour oriented according to the contour orientation,
- the normal to the contour belonging to the profile plane, oriented towards the desired closing side,
- the normal to the plane supporting the contour.
Legal values: 1 for direct axis, -1 for indirect axis.
o ModifyProfile
public virtual void ModifyProfile( const CATISpecObject_var& ihElt) = 0
Sets a new element as profile.
Parameters:
ihElt
The profile element. Typically a Sketch.
o ModifyStartInit
public virtual void ModifyStartInit( const CATISpecObject_var& ihInit) = 0
Sets the first limit limiting element in case the type is catUpToPlaneLimit or catUpToSurfaceLimit.
Parameters:
ihInit
The limiting element.
For the catUpToPlaneLimit type, it must be a plane feature or a planar FSur feature (CATIMfFsur).
For the catUpToSurfaceLimit type, it must be a face feature.
If this face belongs to some surfacic geometry, it must be a FSur feature. Then the entire surface is used to limit the shape.
If it is a face of a volume, it must be a RSur feature (CATIMfRsur) which belongs to the body in which the limited feature is created. In this case the limiting surface is defined by a propagation on the surface of the body starting from the init face.
o ModifyStartOffset
public virtual void ModifyStartOffset(double iOffset) = 0
Sets the second limit offset value in case the type is catOffsetLimit.
Parameters:
iOffset
The offset value.
o ModifyStartType
public virtual void ModifyStartType(int iType) = 0
Sets the second limit type.
Parameters:
iType
The type.
Legal values: They are provided with the CatLimitMode enum.
See also:
CATIPrtSimpleLimit
o ModifySym
public virtual void ModifySym(int iSym) = 0
Sets the symmetrical extension property.
Parameters:
iSym
The symmetry flag.
Legal values: 1 for symmetry, 0 otherwise.
o ReverseDirection
public virtual void ReverseDirection()= 0
Reverses the specified direction.
o SetMergeThin
public virtual void SetMergeThin( const int iMergeThin) =0
Sets the lateral relimitation status for a thin prism. = 0 no lateral relimitation = 1 lateral relimitation
o SetNeutralFiber
public virtual void SetNeutralFiber( const int iNeutralFiber) = 0
Sets the neutral fiber status for a thin prism. = 0 neutral fiber inactivated = 1 neutral fiber activated
o SetThickThin1
public virtual void SetThickThin1( const double iThick) = 0
Sets the value of the first thickness of a thin prism.
o SetThickThin2
public virtual void SetThickThin2( const double iThick)= 0
Sets the value of the second thickness of a thin prism.
o SetThinCheck
public virtual void SetThinCheck( const int iThinCheck) = 0
Sets the thin status for a prism. = 0 prism not thin = 1 prism thin

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

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