Library | PackageFrames | Expand Java Toolkit

Interface WDetailSymbolInstItem

package com.ptc.wfc.wfcDetail;

public interface WDetailSymbolInstItem
  extends com.ptc.wfc.wfcAnnotation.Annotation,
          com.ptc.pfc.pfcDetail.DetailSymbolInstItem


Description

Extends the functionality of DetailSymbolInstItem

This is the actual type of Detail SymbolInst Items in Object Toolkit.


Method Summary
voidAddLeader (Attachment LeaderAttach)
     
voidAddVarText (DetailVariantText Text)
    Add variable text to the symbol instance.
AnnotationPlaneGetAnnotationPlane ()
LICENSE: 222
     
/*optional*/ DimensionGetAttachedDimension ()
    Finds the dimension to which the symbol instance is directly attached.
DetailEntityInstructionsGetEntityInstructions (DetailEntityItem Item)
LICENSE: 222
    Gets data of an entity in the symbol instance.
/*optional*/ FeatureGetFeature ()
    Return the feature that is shown the detail symbol instance.
DetailNoteInstructionsGetNoteInstructions (DetailNoteItem Item, DimDisplayMode DispMode)
LICENSE: 222
    Gets data of a note in the symbol instance.
voidSetAnnotationPlane (AnnotationPlane AnnotPlane)
LICENSE: 222
     

Methods Inherited from Interface com.ptc.wfc.wfcLayerState.LayerItem
IsLayerItemVisible, RemoveNoUpdate, GetLayers, AddNoUpdate

Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource
AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent
GetChild

Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner
GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WParameterOwner
ExportParameterTable, ApplyParameterTableset, MathcadParametersSet, MathcadInputParametersGet

Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner
DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WRelationOwner
GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Interface com.ptc.pfc.pfcObject.Child
GetDBParent, GetOId

Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem
GetName, SetName, GetId, GetType

Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WModelItem
DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Methods Inherited from Interface com.ptc.wfc.wfcAnnotation.Annotation
ShowInDrawing, Display, DisplayInDrawing, Undisplay, UndisplayInDrawing, IsShown, Update, GetTextStyle, SetTextStyle, GetTextStyleInDrawing, SetTextStyleInDrawing, UpdateAttachment, UpdatePosition, IsAssociative, GetAttachmentAssociativity, GetAnnotationElement, IsInactive, Rotate, ConvertLegacy, NeedsConversion, GetSecurityMarking, SetSecurityMarking, IsUsingXSecReference

Methods Inherited from Interface com.ptc.pfc.pfcDetail.DetailItem
GetDetailType, Delete

Methods Inherited from Interface com.ptc.pfc.pfcDetail.DetailSymbolInstItem
Draw, Erase, Show, Remove, GetInstructions, Modify, ListGroups

Method Detail

GetAttachedDimension

/*optional*/ DimensionGetAttachedDimension ()


    Finds the dimension to which the symbol instance is directly attached.

Exceptions thrown (but not limited to):

XToolkitNotExist - The symbol instance is not placed on item to a dimension

XToolkitBadContext - The symbol instance is placed on a dim but we are unable to fill in the output structure on account of the dimension's model being missing (perhaps it was suppressed in the assembly).


Returns:
The dimension to which the symbol instance is directly attached.

AddLeader

voidAddLeader (Attachment LeaderAttach)


     

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.


Parameters:
LeaderAttach
 
Returns:

AddVarText

voidAddVarText (DetailVariantText Text)


    Add variable text to the symbol instance.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.


Parameters:
Text
The variable text.
Returns:

GetFeature

/*optional*/ FeatureGetFeature ()


    Return the feature that is shown the detail symbol instance.

Exceptions thrown (but not limited to):

XToolkitNotFound - The symbol instance is not generated from a solid model feature.


Returns:
The feature (i.e. weld feature) that produces the symbol.

SetAnnotationPlane

voidSetAnnotationPlane (AnnotationPlane AnnotPlane)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitBadContext - Annotation plane is not appropriate for this data.


Manual References:
Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols
Parameters:
AnnotPlane
 
Returns:

GetAnnotationPlane

AnnotationPlaneGetAnnotationPlane ()

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitBadContext - Annotation plane is not appropriate for this data.


Manual References:
Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols, Annotations: Annotation Features and Annotations: Creating, Reading and Modifying 3D Symbols
Returns:
 

GetEntityInstructions

DetailEntityInstructionsGetEntityInstructions (DetailEntityItem Item)

LICENSE: 222

    Gets data of an entity in the symbol instance.

Exceptions thrown (but not limited to):

XToolkitNotFound - No symbols were found in the model.


Parameters:
Item
The entity attached to symbol instance.
Returns:
The entity data in symbol instance space.

GetNoteInstructions

DetailNoteInstructionsGetNoteInstructions (DetailNoteItem Item, DimDisplayMode DispMode)

LICENSE: 222

    Gets data of a note in the symbol instance.

Exceptions thrown (but not limited to):

XToolkitNotFound - No symbols were found in the model.


Parameters:
Item
The pfcDetailNoteItem attached to symbol instance.
DispMode
The display mode.
Returns:
The note data in symbol instance space encapsulated in pfcDetailNoteInstructions_ptr.