All Frameworks  Object Hierarchy  This Framework  Indexes

Plane (Object)

Represents the hybrid shape Plane feature object.
Role: Declare hybrid shape Plane root feature object. All interfaces for different type of Plane derivates HybridShapePlane.

Use the CATIAHybridShapeFactory to create a HybridShapePlane objects.

See also:
HybridShapeFactory

Method Index

GetFirstAxis
Returns the coordinates of the first plane axis.
GetOrigin
Returns the origin of the plane.
GetPosition
Gets the position where the plane is displayed.
GetSecondAxis
Returns the coordinates of the second plane axis.
IsARefPlane
Queries whether the plane is a reference plane (fixed axis plane).
PutFirstAxis
Sets the first axis.
PutOrigin
Sets the origin of the plane.
PutSecondAxis
Sets the coordinates of the second plane axis.
RemovePosition
Removes reference position of a plane.
SetPosition
Sets the position where the plane is displayed.

Methods


o Sub GetFirstAxis( oFirstAxis)
Returns the coordinates of the first plane axis.
Parameters:
oFirstAxis[0]
The X Coordinate of the first plane axis
oFirstAxis[1]
The Y Coordinate of the first plane axis
oFirstAxis[2]
The Z Coordinate of the first plane axis
See also:
HybridShapeFactory
o Sub GetOrigin( oOrigin)
Returns the origin of the plane.
Parameters:
oOrigin[0]
The X Coordinate of the plane origin
oOrigin[1]
The Y Coordinate of the plane origin
oOrigin[2]
The Z Coordinate of the plane origin
See also:
HybridShapeFactory
o Sub GetPosition( oX,
oY,
oZ)
Gets the position where the plane is displayed.
Parameters:
oX
X coordinates
oY
Y coordinates
oZ
Z coordinates
Returns:
S_OK if the position has been set before, E_FAIL else.
o Sub GetSecondAxis( oSecondAxis)
Returns the coordinates of the second plane axis.
Parameters:
oSecondAxis[0]
The X Coordinate of the second plane axis
oSecondAxis[1]
The Y Coordinate of the second plane axis
oSecondAxis[2]
The Z Coordinate of the second plane axis
See also:
HybridShapeFactory
o Func IsARefPlane() As
Queries whether the plane is a reference plane (fixed axis plane).
Returns:
0 when the plane is a reference plane, 1 else.
o Sub PutFirstAxis( iFirstAxis)
Sets the first axis. The first plane axis must be a point-direction line.
Note: This method can only be used on CATIAHybridShapePlane2Lines feature
Parameters:
iFirstAxis[0]
The X Coordinate of the first plane axis
iFirstAxis[1]
The Y Coordinate of the first plane axis
iFirstAxis[2]
The Z Coordinate of the first plane axis
See also:
HybridShapeFactory
o Sub PutOrigin( iOrigin)
Sets the origin of the plane.
Note: This method can only be used on CATIAHybridShapePlane2Lines feature
Parameters:
iOrigin[0]
The X Coordinate of the plane origin
iOrigin[1]
The Y Coordinate of the plane origin
iOrigin[2]
The Z Coordinate of the plane origin
See also:
HybridShapeFactory
o Sub PutSecondAxis( iSecondAxis)
Sets the coordinates of the second plane axis. The second plane axis must be a point-direction line
Note: This method can only be used on CATIAHybridShapePlane2Lines feature
Parameters:
iSecondAxis[0]
The X Coordinate of the second plane axis
iSecondAxis[1]
The Y Coordinate of the second plane axis
iSecondAxis[2]
The Z Coordinate of the second plane axis
See also:
HybridShapeFactory
o Sub RemovePosition()
Removes reference position of a plane.
Note: When removed, the plane is displayed at its default position.
o Sub SetPosition( iX,
iY,
iZ)
Sets the position where the plane is displayed.
Parameters:
iX
X coordinates
iY
Y coordinates
iZ
Z coordinates

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