All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

HybridShapeDirection (Object)

IUnknown
  |
  +---IDispatch
    |
    +---CATBaseUnknown
      |
      +---CATBaseDispatch
        |
        +---AnyObject
          |
          +---HybridShape
            |
            +---HybridShapeDirection
 


Represents the hybrid shape direction feature object.
Role: To access the data of the hybrid shape direction feature object. A direction can be specified using:

Use the CATIAHybridShapeFactory to create a HybridShapeDirection object.

See also:
HybridShapeFactory

Property Index

Object
Returns or sets the object that specifies the direction.
RefAxisSystem
Returns or Sets the reference Axis System for Direction feature.
Type
Returns the direction type.

Method Index

DirectionSpecification
Queries the direction specification status.
GetX
Returns the direction X component.
GetXVal
Returns the direction X component as Double.
GetY
Returns the direction Y component.
GetYVal
Returns the direction Y component as Double.
GetZ
Returns the direction Z component.
GetZVal
Returns the direction Z component as Double.

Properties


o Property Object() As CATIAReference
Returns or sets the object that specifies the direction.
This object can be a line or a plane.
Parameters:
oObject
The object (a line or a plane) that specifies the direction

Sub-element(s) supported (see
Boundary object): RectilinearTriDimFeatEdge, RectilinearBiDimFeatEdge or RectilinearMonoDimFeatEdge.
o Property RefAxisSystem() As CATIAReference
Returns or Sets the reference Axis System for Direction feature.
This data is not mandatory, if element is null, the absolute axis system is taken.
When an element is given, X, Y and Z are considered in this Axis system.
Example
:
This example retrieves in oRefAxis the reference Axis System for Direction feature.
 Dim oRefAxis As CATIAReference
 Set oRefAxis  = Direction.RefAxisSystem
 
o Property Type() As long (Read Only)
Returns the direction type.
Legal value: The direction type can be:
0
The direction is specified using an object (a line or a plane). In the case of a plane, the direction is the normal to the plane
1
The direction is specified using its components

Methods


o Func DirectionSpecification() As long
Queries the direction specification status.
Parameters:
oDir
direction specification = 0 : Direction is not specified. = 1 : Direction is specified and is valid. = -1 : Direction is specified but is not valid.
o Func GetX() As CATIARealParam
Returns the direction X component. This method succeeds only when direction is specified using components. It fails when direction is specified using a geometrical element i.e Line, Plane. In such cases use GetXVal method instead.
Parameters:
oCoordinates
The direction X component
o Func GetXVal() As double
Returns the direction X component as Double. This method succeeds irrespective of the way direction is specified.
Parameters:
oX
The direction X component
o Func GetY() As CATIARealParam
Returns the direction Y component. This method succeeds only when direction is specified using components. It fails when direction is specified using a geometrical element i.e Line, Plane. In such cases use GetYVal method instead.
Parameters:
oCoordinates
The direction Y component
o Func GetYVal() As double
Returns the direction Y component as Double.This method succeeds irrespective of the way direction is specified.
Parameters:
oY
The direction Y component
o Func GetZ() As CATIARealParam
Returns the direction Z component. This method succeeds only when direction is specified using components. It fails when direction is specified using a geometrical element i.e Line, Plane. In such cases use GetZVal method instead.
Parameters:
oCoordinates
The direction Z component
o Func GetZVal() As double
Returns the direction Z component as Double.This method succeeds irrespective of the way direction is specified.
Parameters:
oZ
The direction Z component

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