CATGSMIDLItf HybridShapeDirection (Object)

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:

A line: the direction is tangent to the line
A plane: the direction is normal to the plane
Its components

Use the CATIAHybridShapeFactory to create a HybridShapeDirection object.

See also:

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

Property Object() As

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 object): , or .

Property RefAxisSystem() As

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

Property Type() As (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

Func DirectionSpecification() As

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.

Func GetX() As

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

Func GetXVal() As

Returns the direction X component as Double. This method succeeds irrespective of the way direction is specified.

Parameters:

oX: The direction X component

Func GetY() As

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

Func GetYVal() As

Returns the direction Y component as Double.This method succeeds irrespective of the way direction is specified.

Parameters:

oY: The direction Y component

Func GetZ() As

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

Func GetZVal() As

Returns the direction Z component as Double.This method succeeds irrespective of the way direction is specified.

Parameters:

oZ: The direction Z component