CIP JavaScript documentation for class " pfcComponentConstraint"

Class pfcComponentConstraint

Description

This interface represents a component constraint.

Property Summary


`/* optional */ pfcDatumSide`	`AssemblyDatumSide`
	The datum plane side, if the AssemblyReference is a datum plane.

`/* optional */ pfcSelection`	`AssemblyReference`
	The geometric reference from the assembly. This reference must be created using an assembly component path. Use `null` for constraint types not requiring a component reference.

`/* optional */ pfcConstraintAttributes`	`Attributes`
	Constraint related attributed. Use `null` for the default settings.

`/* optional */ pfcDatumSide`	`ComponentDatumSide`
	The datum plane side, if the ComponentReference is a datum plane.

`/* optional */ pfcSelection`	`ComponentReference`
	The geometric reference on the component. Use `null` for constraint types not requiring a component reference.

`/* optional */ number`	`Offset`
	The offset value, if appropriate to the constraint type. Use `null` to represent a 0.0 value, or for constraint types not requiring an offset.

`pfcComponentConstraintType`	`Type`
	The type of constraint.

`/* optional */ string`	`UserDefinedData`
	A user created string stored with the constraint. Typically `null`.

Method Summary


`static pfcComponentConstraint`	`Create (pfcComponentConstraintType Type)`
	Creates a new component constraint object.

Property Detail

/* optional */ pfcDatumSide AssemblyDatumSide

The datum plane side, if the AssemblyReference is a datum plane.

/* optional */ pfcSelection AssemblyReference

The geometric reference from the assembly. This reference must be created using an assembly component path. Use null for constraint types not requiring a component reference.

/* optional */ pfcConstraintAttributes Attributes

Constraint related attributed. Use null for the default settings.

/* optional */ pfcDatumSide ComponentDatumSide

The datum plane side, if the ComponentReference is a datum plane.

/* optional */ pfcSelection ComponentReference

The geometric reference on the component. Use null for constraint types not requiring a component reference.

/* optional */ number Offset

The offset value, if appropriate to the constraint type. Use null to represent a 0.0 value, or for constraint types not requiring an offset.

pfcComponentConstraintType Type

The type of constraint.

/* optional */ string UserDefinedData

A user created string stored with the constraint. Typically null.

Method Detail

static pfcComponentConstraint Create (pfcComponentConstraintType Type)

Creates a new component constraint object.

See Also:: pfcComponentFeat.SetConstraints()

Parameters:

Type: The type of constraint.

Returns:: The new component constraint object.