CIP JAVA documentation for class "com.ptc.pfc.pfcDetail.DetailSymbolInstInstructions"

Interface DetailSymbolInstInstructions

package com.ptc.pfc.pfcDetail; public interface DetailSymbolInstInstructions extends com.ptc.pfc.pfcDetail.DetailCreateInstructions

Description

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

See Also:: DetailItemOwner.CreateDetailItem(DetailCreateInstructions), DetailItemOwner.GetDetailItem(DetailType, int), DetailItemOwner.ListDetailItems(/*optional*/ DetailType, /*optional*/ Integer), DetailItemOwner.RetrieveSymbolDefinition(String, /*optional*/ String, /*optional*/ Integer, /*optional*/ Boolean), pfcDetail.SymbolDefAttachment_Create(SymbolDefAttachmentType, Point3D), pfcDetail.DetailLeaders_Create(), pfcDetail.DetailVariantText_Create(String, String)

Method Summary
`/optional/ Double`	`GetAngle ()` Get method for attribute "Angle" The angle at which the instance was placed. `null` represents a 0.0 degree angle.
`/optional/ SymbolDefAttachmentType`	`GetAttachOnDefType ()` Get method for attribute "AttachOnDefType" The instance attachment type. `null` represents a free attachment.
`/optional/ ColorRGB`	`GetColor ()` Get method for attribute "Color" The color of the detail item. If `null`, the default drawing color is used.
`Transform3D`	`GetCurrentTransform ()` Get method for attribute "CurrentTransform" The coordinate transformation matrix for the symbol instance placement.
`/optional/ SymbolDefAttachment`	`GetDefAttachment ()` Get method for attribute "DefAttachment" The attachment on the symbol definition.
`/optional/ Double`	`GetHeight ()` Get method for attribute "Height" The symbol instance height.
`/optional/ DetailLeaders`	`GetInstAttachment ()` Get method for attribute "InstAttachment" The attachment of the instance, including leader information.
`/optional/ Boolean`	`GetIsDisplayed ()` Get method for attribute "IsDisplayed" Whether or not the symbol instance is displayed.
`/optional/ Double`	`GetScaledHeight ()` Get method for attribute "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.
`DetailSymbolDefItem`	`GetSymbolDef ()` Get method for attribute "SymbolDef" The symbol definition used for the instance.
`/optional/ DetailVariantTexts`	`GetTextValues ()` Get method for attribute "TextValues" Sequence of variant text values used while placing the symbol instance.
`void`	`SetAngle ( /optional/ Double value)` Set method for attribute "Angle" The angle at which the instance was placed. `null` represents a 0.0 degree angle.
`void`	`SetAttachOnDefType ( /optional/ SymbolDefAttachmentType value)` Set method for attribute "AttachOnDefType" The instance attachment type. `null` represents a free attachment.
`void`	`SetColor ( /optional/ ColorRGB value)` Set method for attribute "Color" The color of the detail item. If `null`, the default drawing color is used.
`void`	`SetDefAttachment ( /optional/ SymbolDefAttachment value)` Set method for attribute "DefAttachment" The attachment on the symbol definition.
`void`	`SetGroups (DetailSymbolGroupOption option, /optional/ DetailSymbolGroups groups)` Sets the option for displaying groups in the symbol instance.
`void`	`SetHeight ( /optional/ Double value)` Set method for attribute "Height" The symbol instance height.
`void`	`SetInstAttachment ( /optional/ DetailLeaders value)` Set method for attribute "InstAttachment" The attachment of the instance, including leader information.
`void`	`SetIsDisplayed ( /optional/ Boolean value)` Set method for attribute "IsDisplayed" Whether or not the symbol instance is displayed.
`void`	`SetScaledHeight ( /optional/ Double value)` Set method for attribute "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.
`void`	`SetSymbolDef (DetailSymbolDefItem value)` Set method for attribute "SymbolDef" The symbol definition used for the instance.
`void`	`SetTextValues ( /optional/ DetailVariantTexts value)` Set method for attribute "TextValues" Sequence of variant text values used while placing the symbol instance.

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailCreateInstructions`
`GetType`, `GetId`

Method Detail

GetIsDisplayed/SetIsDisplayed

`/optional/ Boolean`	`GetIsDisplayed`	`()`
`void`	`SetIsDisplayed`	`( /optional/ Boolean value)`

Whether or not the symbol instance is displayed.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

GetColor/SetColor

`/optional/ ColorRGB`	`GetColor`	`()`
`void`	`SetColor`	`( /optional/ ColorRGB value)`

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

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

GetSymbolDef/SetSymbolDef

`DetailSymbolDefItem`	`GetSymbolDef`	`()`
`void`	`SetSymbolDef`	`(DetailSymbolDefItem value)`

The symbol definition used for the instance.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

GetAttachOnDefType/SetAttachOnDefType

`/optional/ SymbolDefAttachmentType`	`GetAttachOnDefType`	`()`
`void`	`SetAttachOnDefType`	`( /optional/ SymbolDefAttachmentType value)`

The instance attachment type. null represents a free attachment.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

GetDefAttachment/SetDefAttachment

`/optional/ SymbolDefAttachment`	`GetDefAttachment`	`()`
`void`	`SetDefAttachment`	`( /optional/ SymbolDefAttachment value)`

The attachment on the symbol definition.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

XToolkitNotFound - No symbol definition for the specified symbol instance.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

GetInstAttachment/SetInstAttachment

`/optional/ DetailLeaders`	`GetInstAttachment`	`()`
`void`	`SetInstAttachment`	`( /optional/ DetailLeaders value)`

The attachment of the instance, including leader information.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

XToolkitNotFound - No leaders were found.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

GetAngle/SetAngle

`/optional/ Double`	`GetAngle`	`()`
`void`	`SetAngle`	`( /optional/ Double value)`

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

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

GetHeight/SetHeight

`/optional/ Double`	`GetHeight`	`()`
`void`	`SetHeight`	`( /optional/ Double value)`

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 DetailSymbolInstInstructions.GetScaledHeight(/*optional*/ Double) instead.

GetScaledHeight/SetScaledHeight

`/optional/ Double`	`GetScaledHeight`	`()`
`void`	`SetScaledHeight`	`( /optional/ Double value)`

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 DetailSymbolInstInstructions.GetSymbolDef(DetailSymbolDefItem)). Changing the symbol definition may change how Creo Parametric calculates the symbol height based on the scaled height.

Exceptions thrown (but not limited to):

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

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

GetTextValues/SetTextValues

`/optional/ DetailVariantTexts`	`GetTextValues`	`()`
`void`	`SetTextValues`	`( /optional/ DetailVariantTexts value)`

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

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

XToolkitNotFound - No variant text values were found.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

GetCurrentTransform

Transform3D GetCurrentTransform ()

The coordinate transformation matrix for the symbol instance placement.

Manual References:: Drawings: Detail Symbol Instances, Drawings: Detail Symbol Instances

SetGroups

void SetGroups (DetailSymbolGroupOption option, /*optional*/ DetailSymbolGroups groups)

Sets the option for displaying groups in the symbol instance.

Manual References:: Drawings: Detail Symbol Instances

Parameters:

option
groups

Returns: