NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Annotations::CalloutGroupBuilder Class Reference

Represents a NXOpen::Annotations::CalloutGroupBuilder
To create a new instance of this class, use NXOpen::Annotations::IdSymbolCollection::CreateCalloutGroupBuilder

Created in NX7.5.0. More...

Inheritance diagram for NXOpen::Annotations::CalloutGroupBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Layout { LayoutHorizontal, LayoutVertical }
 Represents group layout. More...
 
enum  Mode { ModeGroup, ModeUngroup }
 Represents Group or Ungroup mode. More...
 
enum  VerticalGroupLeaderAttachment { VerticalGroupLeaderAttachmentTop, VerticalGroupLeaderAttachmentBottom }
 Represents leader attachment for vertical callout groups. More...
 

Public Member Functions

NXOpen::Annotations::CalloutGroupBuilder::Mode CalloutModeType ()
 Returns the mode
Created in NX7.5.0. More...
 
std::vector
< NXOpen::Annotations::IdSymbol * > 
GetGroupSymbols ()
 Gets the symbols which are grouped. More...
 
NXOpen::Annotations::CalloutGroupBuilder::Layout LayoutType ()
 Returns the layout type
Created in NX7.5.0. More...
 
NXOpen::SelectDisplayableObjectListSelectCallout ()
 Returns the selected callout
Created in NX7.5.0. More...
 
void SetCalloutModeType (NXOpen::Annotations::CalloutGroupBuilder::Mode mode)
 Sets the mode
Created in NX7.5.0. More...
 
void SetGroupSymbols (const std::vector< NXOpen::Annotations::IdSymbol * > &symbols)
 Groups or UnGroups the symbols based on NXOpen::Annotations::CalloutGroupBuilder::Mode . More...
 
void SetLayoutType (NXOpen::Annotations::CalloutGroupBuilder::Layout layout)
 Sets the layout type
Created in NX7.5.0. More...
 
void SetVerticalLeaderAttachment (NXOpen::Annotations::CalloutGroupBuilder::VerticalGroupLeaderAttachment position)
 Sets the leader attachment to vertical callout groups
Created in NX9.0.0. More...
 
NXOpen::Annotations::CalloutGroupBuilder::VerticalGroupLeaderAttachment VerticalLeaderAttachment ()
 Returns the leader attachment to vertical callout groups
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Annotations::CalloutGroupBuilder
To create a new instance of this class, use NXOpen::Annotations::IdSymbolCollection::CreateCalloutGroupBuilder

Created in NX7.5.0.


Member Enumeration Documentation

Represents group layout.

Enumerator
LayoutHorizontal 

Horizontal.

LayoutVertical 

Vertical.

Represents Group or Ungroup mode.

Use the correct mode before builder commit operation.

Enumerator
ModeGroup 

Group.

ModeUngroup 

Ungroup.

Represents leader attachment for vertical callout groups.

Enumerator
VerticalGroupLeaderAttachmentTop 

Top.

VerticalGroupLeaderAttachmentBottom 

Bottom.

Member Function Documentation

NXOpen::Annotations::CalloutGroupBuilder::Mode NXOpen::Annotations::CalloutGroupBuilder::CalloutModeType ( )

Returns the mode
Created in NX7.5.0.



License requirements : None

std::vector<NXOpen::Annotations::IdSymbol *> NXOpen::Annotations::CalloutGroupBuilder::GetGroupSymbols ( )

Gets the symbols which are grouped.

Returns

Created in NX7.5.0.

License requirements : None
NXOpen::Annotations::CalloutGroupBuilder::Layout NXOpen::Annotations::CalloutGroupBuilder::LayoutType ( )

Returns the layout type
Created in NX7.5.0.



License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Annotations::CalloutGroupBuilder::SelectCallout ( )

Returns the selected callout
Created in NX7.5.0.



License requirements : None

void NXOpen::Annotations::CalloutGroupBuilder::SetCalloutModeType ( NXOpen::Annotations::CalloutGroupBuilder::Mode  mode)

Sets the mode
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
modemode
void NXOpen::Annotations::CalloutGroupBuilder::SetGroupSymbols ( const std::vector< NXOpen::Annotations::IdSymbol * > &  symbols)

Groups or UnGroups the symbols based on NXOpen::Annotations::CalloutGroupBuilder::Mode .


Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters
symbolssymbols
void NXOpen::Annotations::CalloutGroupBuilder::SetLayoutType ( NXOpen::Annotations::CalloutGroupBuilder::Layout  layout)

Sets the layout type
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
layoutlayout
void NXOpen::Annotations::CalloutGroupBuilder::SetVerticalLeaderAttachment ( NXOpen::Annotations::CalloutGroupBuilder::VerticalGroupLeaderAttachment  position)

Sets the leader attachment to vertical callout groups
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
positionposition
NXOpen::Annotations::CalloutGroupBuilder::VerticalGroupLeaderAttachment NXOpen::Annotations::CalloutGroupBuilder::VerticalLeaderAttachment ( )

Returns the leader attachment to vertical callout groups
Created in NX9.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.