CIP JavaScript documentation for class " pfcDetailSymbolInstInstructions"

Class pfcDetailSymbolInstInstructions

Description

This interface contains information used to describe a symbol instance. It may be used when creating symbol instances (pfcDetailItemOwner.CreateDetailItem()), or accessing existing groups (pfcDetailSymbolInstItem.Modify() and pfcDetailSymbolInstItem.GetInstructions()).

See Also:: pfcDetailItemOwner.CreateDetailItem(), pfcDetailItemOwner.GetDetailItem(), pfcDetailItemOwner.ListDetailItems(), pfcDetailItemOwner.RetrieveSymbolDefinition(), pfcSymbolDefAttachment.Create(), pfcDetailLeaders.Create(), pfcDetailVariantText.Create()

Direct Parent Classes:: pfcDetailCreateInstructions

Property Summary


`/* optional */ number`	`Angle`
	The angle at which the instance was placed. `null` represents a 0.0 degree angle.

`/* optional */ pfcSymbolDefAttachmentType`	`AttachOnDefType`
	The instance attachment type. `null` represents a free attachment.

`/* optional */ pfcColorRGB`	`Color`
	The color of the detail item. If `null`, the default drawing color is used.

`/* readonly */ pfcTransform3D`	`CurrentTransform`
	The coordinate transformation matrix for the symbol instance placement.

`/* optional */ pfcSymbolDefAttachment`	`DefAttachment`
	The attachment on the symbol definition.

`/* optional */ number`	`Height`
	The symbol instance height.

`/* optional */ pfcDetailLeaders`	`InstAttachment`
	The attachment of the instance, including leader information.

`/* optional */ boolean`	`IsDisplayed`
	Whether or not the symbol instance is displayed.

`/* optional */ number`	`ScaledHeight`
	The symbol instance height in the units of the drawing or model, consistent with the values shown in the Properties dialog for the symbol instance.

`pfcDetailSymbolDefItem`	`SymbolDef`
	The symbol definition used for the instance.

`/* optional */ pfcDetailVariantTexts`	`TextValues`
	Sequence of variant text values used while placing the symbol instance.

Method Summary


`static pfcDetailSymbolInstInstructions`	`Create (pfcDetailSymbolDefItem inSymbolDef)`
	Creates a data object containing information about a symbol instance placement. Pass this object to `pfcDetailItemOwner.CreateDetailItem()` and `pfcDetailSymbolInstItem.Modify()`.

`void`	`SetGroups (pfcDetailSymbolGroupOption option, /* optional */ pfcDetailSymbolGroups groups)`
	Sets the option for displaying groups in the symbol instance.

Property Detail

/* optional */ number Angle

The angle at which the instance was placed. null represents a 0.0 degree angle.

/* optional */ pfcSymbolDefAttachmentType AttachOnDefType

The instance attachment type. null represents a free attachment.

/* optional */ pfcColorRGB Color

The color of the detail item. If null, the default drawing color is used.

/* readonly */ pfcTransform3D CurrentTransform

The coordinate transformation matrix for the symbol instance placement.

/* optional */ pfcSymbolDefAttachment DefAttachment

The attachment on the symbol definition.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - No symbol definition for the specified symbol instance.

/* optional */ number Height

The symbol instance height.

This function does not consistently return a value capable of being related mathematically to the symbol height in drawing or model coordinates. Use pfcDetailSymbolInstInstructions.ScaledHeight instead.

/* optional */ pfcDetailLeaders InstAttachment

The attachment of the instance, including leader information.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - No leaders were found.

/* optional */ boolean IsDisplayed

Whether or not the symbol instance is displayed.

/* optional */ number ScaledHeight

The symbol instance height in the units of the drawing or model, consistent with the values shown in the Properties dialog for the symbol instance.

The scaled height is partially determined based on the properties of the symbol definition (see pfcDetailSymbolInstInstructions.SymbolDef). Changing the symbol definition may change how Creo Parametric calculates the symbol height based on the scaled height.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The symbol definition assigned to this data was not yet initialized so the scaled value cannot be accurately assigned or retrieved.

pfcDetailSymbolDefItem SymbolDef

The symbol definition used for the instance.

/* optional */ pfcDetailVariantTexts TextValues

Sequence of variant text values used while placing the symbol instance.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - No variant text values were found.

Method Detail

static pfcDetailSymbolInstInstructions Create (pfcDetailSymbolDefItem inSymbolDef)

Creates a data object containing information about a symbol instance placement. Pass this object to pfcDetailItemOwner.CreateDetailItem() and pfcDetailSymbolInstItem.Modify().

Parameters:

inSymbolDef: The symbol definition.

Returns:: The instructions data object.

void SetGroups (pfcDetailSymbolGroupOption option, /* optional */ pfcDetailSymbolGroups groups)

Sets the option for displaying groups in the symbol instance.

Parameters:

option
groups