CIP C++ documentation for class "pfcDetailSymbolInstInstructions"

Class pfcDetailSymbolInstInstructions

# include <pfcDetail.h> class pfcDetailSymbolInstInstructions : public virtual pfcDetailCreateInstructions { xdeclare(pfcDetailSymbolInstInstructions) ... }; This is a COMPACT class.

Description

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

See Also:: pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr), pfcDetailItemOwner::GetDetailItem(pfcDetailType, xint), pfcDetailItemOwner::ListDetailItems(optional pfcDetailType, optional xint), pfcDetailItemOwner::RetrieveSymbolDefinition(xrstring, optional xrstring, optional xint, optional xbool), pfcSymbolDefAttachment::Create(pfcSymbolDefAttachmentType, pfcPoint3D_ptr), pfcDetailLeaders::Create(), pfcDetailVariantText::Create(xrstring, xrstring)

Manual References:: Drawings: Detail Symbol Instances

Method Summary


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

`optional xreal`	`GetAngle ()`
`void`	`SetAngle (optional xreal value)`
	The angle at which the instance was placed. `null` represents a 0.0 degree angle.

`optional pfcSymbolDefAttachmentType`	`GetAttachOnDefType ()`
`void`	`SetAttachOnDefType (optional pfcSymbolDefAttachmentType value)`
	The instance attachment type. `null` represents a free attachment.

`optional pfcColorRGB_ptr`	`GetColor ()`
`void`	`SetColor (optional pfcColorRGB_ptr value)`
	The color of the detail item. If `null`, the default drawing color is used.

`pfcTransform3D_ptr`	`GetCurrentTransform ()`
	The coordinate transformation matrix for the symbol instance placement.

`optional pfcSymbolDefAttachment_ptr`	`GetDefAttachment ()`
`void`	`SetDefAttachment (optional pfcSymbolDefAttachment_ptr value)`
	The attachment on the symbol definition.

`optional xreal`	`GetHeight ()`
`void`	`SetHeight (optional xreal value)`
	The symbol instance height.

`optional pfcDetailLeaders_ptr`	`GetInstAttachment ()`
`void`	`SetInstAttachment (optional pfcDetailLeaders_ptr value)`
	The attachment of the instance, including leader information.

`optional xbool`	`GetIsDisplayed ()`
`void`	`SetIsDisplayed (optional xbool value)`
	Whether or not the symbol instance is displayed.

`optional xreal`	`GetScaledHeight ()`
`void`	`SetScaledHeight (optional xreal 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.

`pfcDetailSymbolDefItem_ptr`	`GetSymbolDef ()`
`void`	`SetSymbolDef (pfcDetailSymbolDefItem_ptr value)`
	The symbol definition used for the instance.

`optional pfcDetailVariantTexts_ptr`	`GetTextValues ()`
`void`	`SetTextValues (optional pfcDetailVariantTexts_ptr value)`
	Sequence of variant text values used while placing the symbol instance.









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

Methods Inherited from Class pfcDetailCreateInstructions:: GetType, GetId

Method Detail

`optional xbool`	`GetIsDisplayed`	`()`
`void`	`SetIsDisplayed`	`(optional xbool 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

`optional pfcColorRGB_ptr`	`GetColor`	`()`
`void`	`SetColor`	`(optional pfcColorRGB_ptr 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

`pfcDetailSymbolDefItem_ptr`	`GetSymbolDef`	`()`
`void`	`SetSymbolDef`	`(pfcDetailSymbolDefItem_ptr 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

`optional pfcSymbolDefAttachmentType`	`GetAttachOnDefType`	`()`
`void`	`SetAttachOnDefType`	`(optional pfcSymbolDefAttachmentType 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

`optional pfcSymbolDefAttachment_ptr`	`GetDefAttachment`	`()`
`void`	`SetDefAttachment`	`(optional pfcSymbolDefAttachment_ptr value)`

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.

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

`optional pfcDetailLeaders_ptr`	`GetInstAttachment`	`()`
`void`	`SetInstAttachment`	`(optional pfcDetailLeaders_ptr value)`

The attachment of the instance, including leader information.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - No leaders were found.

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

`optional xreal`	`GetAngle`	`()`
`void`	`SetAngle`	`(optional xreal 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

`optional xreal`	`GetHeight`	`()`
`void`	`SetHeight`	`(optional xreal 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 pfcDetailSymbolInstInstructions::GetScaledHeight(optional xreal) instead.

`optional xreal`	`GetScaledHeight`	`()`
`void`	`SetScaledHeight`	`(optional xreal 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 pfcDetailSymbolInstInstructions::GetSymbolDef(pfcDetailSymbolDefItem_ptr)). 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.

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

`optional pfcDetailVariantTexts_ptr`	`GetTextValues`	`()`
`void`	`SetTextValues`	`(optional pfcDetailVariantTexts_ptr value)`

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.

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

pfcTransform3D_ptr GetCurrentTransform ()

The coordinate transformation matrix for the symbol instance placement.

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

void SetGroups (pfcDetailSymbolGroupOption option, optional pfcDetailSymbolGroups_ptr groups)

Sets the option for displaying groups in the symbol instance.

Manual References:: Drawings: Detail Symbol Instances

Parameters:

option
groups

Returns:

static pfcDetailSymbolInstInstructions_ptr Create (pfcDetailSymbolDefItem_ptr inSymbolDef)

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

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

Parameters:

inSymbolDef: The symbol definition.

Returns:: The instructions data object.