CATPartUseItf Interface CATIPdgUsePrism
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPdgUsePrism
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:
- ,
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(double&)
- Returns the value of the first thickness of a thin prism.
- o
GetThickThin1(CATICkeParm_var&)
- Returns the parameter links to the first thickness of a thin prism.
- o
GetThickThin2(double&)
- Returns the value of the second thickness of a thin prism.
- o
GetThickThin2(CATICkeParm_var&)
- Returns the parameter links to 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(CATMathDirection&)
- Specifies a mathematical extrusion direction.
- o
ModifyDirection(CATBaseUnknown_var&)
- Specifies an element as reference for the direction.
- o
ModifyEndInit(CATBaseUnknown_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(CATBaseUnknown_var&)
- Sets a new element as profile.
- o
ModifyStartInit(CATBaseUnknown_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
-
Returns the direction internal component.
- Returns:
- The axis feature.
o GetDirection
| public virtual GetDirection( | ) |
-
Returns the extrusion direction.
- Returns:
- The extrusion vector.
o GetEndInit
| public virtual GetEndInit( | ) |
-
Returns the first limit limiting element.
- Returns:
- The element.
o GetEndLimit
| public virtual GetEndLimit( | ) |
-
Returns the internal first limit component.
- Returns:
- The limit feature.
o GetEndOffset
| public virtual GetEndOffset( | ) |
-
Returns the first limit offset value.
- Returns:
- The offset value.
o GetEndType
| public virtual GetEndType( | ) |
-
Returns the first limit type.
- Returns:
- The type.
o GetInnerSide
| public virtual GetInnerSide( | ) |
-
Returns the closing side of the open profile.
- Returns:
- The side flag.
o GetMergeThin
| public virtual GetMergeThin( | | oMergeThin) |
-
Returns the lateral relimitation status for a thin prism.
- Returns:
- = 0 no lateral relimitation
= 1 lateral relimitation
o GetNeutralFiber
| public virtual GetNeutralFiber( | | oNeutralFiber) |
-
Returns the neutral fiber status for a thin prism.
- Returns:
- = 0 neutral fiber inactivated
= 1 neutral fiber activated
o GetProfile
| public virtual GetProfile( | ) |
-
Returns the profile internal component.
- Returns:
- The profile.
o GetReferenceDir
| public virtual GetReferenceDir( | ) |
-
Returns the reference element which specifies the direction.
- Returns:
- The reference element.
o GetStartInit
| public virtual GetStartInit( | ) |
-
Returns the second limit limiting element.
- Returns:
- The element.
o GetStartLimit
| public virtual GetStartLimit( | ) |
-
Returns the second limit internal component.
- Returns:
- The limit feature.
o GetStartOffset
| public virtual GetStartOffset( | ) |
-
Returns the second limit offset value.
- Returns:
- The offset value.
o GetStartType
| public virtual GetStartType( | ) |
-
Returns the second limit type.
- Returns:
- The type.
o GetSym
-
Tests whether the symmetrical extension is set or not.
- Returns:
- The symmetry flag.
Legal values: 1 for symmetry, 0 otherwise.
o GetThickThin1
| public virtual GetThickThin1( | | oThick) |
-
Returns the value of the first thickness of a thin prism.
- Returns:
- The value.
o GetThickThin1
| public virtual GetThickThin1( | | oThickParm) |
-
Returns the parameter links to the first thickness of a thin prism.
- Returns:
- The parameter.
o GetThickThin2
| public virtual GetThickThin2( | | oThick) |
-
Returns the value of the second thickness of a thin prism.
- Returns:
- The value.
o GetThickThin2
| public virtual GetThickThin2( | | oThickParm) |
-
Returns the parameter links to the second thickness of a thin prism.
- Returns:
- The parameter.
o GetThinCheck
| public virtual GetThinCheck( | | oThinCheck) |
-
Returns the thin status for a prism.
- Returns:
- = 0 prism not thin
= 1 prism thin
o IsDirectionReversed
| public virtual IsDirectionReversed( | ) |
-
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 ModifyDirection( | const | iDir) |
-
Specifies a mathematical extrusion direction.
- Parameters:
-
- iDir
- The direction vector.
o ModifyDirection
| public virtual ModifyDirection( | const | ihDir_input) |
-
Specifies an element as reference for the direction.
- Parameters:
-
- ihDir
- The reference element.
o ModifyEndInit
| public virtual ModifyEndInit( | const | ihInit_input) |
-
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 ModifyEndOffset( | | iOffset) |
-
Sets the first limit offset value in case the type is catOffsetLimit.
- Parameters:
-
- iOffset
- The offset value.
o ModifyEndType
| public virtual ModifyEndType( | | iType) |
-
Sets the first limit type.
- Parameters:
-
- iType
- The type.
Legal values: They are provided with the CatLimitMode enum.
- See also:
-
o ModifyInnerSide
| public virtual ModifyInnerSide( | | iSide) |
-
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 ModifyProfile( | const | ihElt_input) |
-
Sets a new element as profile.
- Parameters:
-
- ihElt
- The profile element. Typically a Sketch.
o ModifyStartInit
| public virtual ModifyStartInit( | const | ihInit_input) |
-
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 ModifyStartOffset( | | iOffset) |
-
Sets the second limit offset value in case the type is catOffsetLimit.
- Parameters:
-
- iOffset
- The offset value.
o ModifyStartType
| public virtual ModifyStartType( | | iType) |
-
Sets the second limit type.
- Parameters:
-
- iType
- The type.
Legal values: They are provided with the CatLimitMode enum.
- See also:
-
o ModifySym
| public virtual ModifySym( | | iSym) |
-
Sets the symmetrical extension property.
- Parameters:
-
- iSym
- The symmetry flag.
Legal values: 1 for symmetry, 0 otherwise.
o ReverseDirection
| public virtual ReverseDirection( | ) |
-
Reverses the specified direction.
o SetMergeThin
| public virtual SetMergeThin( | const | iMergeThin) |
-
Sets the lateral relimitation status for a thin prism.
= 0 no lateral relimitation
= 1 lateral relimitation
o SetNeutralFiber
| public virtual SetNeutralFiber( | const | iNeutralFiber) |
-
Sets the neutral fiber status for a thin prism.
= 0 neutral fiber inactivated
= 1 neutral fiber activated
o SetThickThin1
| public virtual SetThickThin1( | const | iThick) |
-
Sets the value of the first thickness of a thin prism.
o SetThickThin2
| public virtual SetThickThin2( | const | iThick) |
-
Sets the value of the second thickness of a thin prism.
o SetThinCheck
| public virtual SetThinCheck( | const | iThinCheck) |
-
Sets the thin status for a prism.
= 0 prism not thin
= 1 prism thin
This object is included in the file: CATIPdgUsePrism.h
If needed, your Imakefile.mk should include the module: CATPartUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.