NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Diagramming::NodeBuilder Class Reference

Represents a NodeBuilder. More...

Inheritance diagram for NXOpen::Diagramming::NodeBuilder:
NXOpen::Diagramming::ConnectableElementBuilder NXOpen::Diagramming::SheetElementBuilder NXOpen::Diagramming::BaseObjectBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void AddGroupMember (NXOpen::Diagramming::SheetElement *member)
 Adds a node to this node group. More...
 
bool Expanded ()
 Returns the node state of expanded or collapsed. More...
 
bool Fullfillment ()
 Returns the flag that indicates if the node is a fulfillment object. More...
 
bool GroupingAllowed ()
 Returns the flag that indicates if the node is allowed to be a nested node and contain other child sheet elements. More...
 
NXOpen::Diagramming::NodeOffsheetReference ()
 Returns the referenced offsheet node. More...
 
void RemoveAllGroupMembers ()
 Remove all members. More...
 
void RemoveGroupMember (NXOpen::Diagramming::SheetElement *member)
 Removes a node from this node group. More...
 
void SetExpanded (bool expanded)
 Sets the node state of expanded or collapsed. More...
 
void SetGroupingAllowed (bool isGroupingAllowed)
 Sets the flag that indicates if the node is allowed to be a nested node and contain other child sheet elements. More...
 
void SetOffsheetReference (NXOpen::Diagramming::Node *offsheetReference)
 Sets the referenced offsheet node. More...
 
- Public Member Functions inherited from NXOpen::Diagramming::ConnectableElementBuilder
std::vector
< NXOpen::Diagramming::Port * > 
GetAllPorts ()
 Gets all ports of this connectable element. More...
 
std::vector
< NXOpen::Diagramming::Port * > 
GetPorts (NXOpen::Diagramming::Direction direction)
 Gets ports of this connectable element by the direction. More...
 
- Public Member Functions inherited from NXOpen::Diagramming::SheetElementBuilder
void GetAllowedTransformations (bool *isAllowedTranslation, bool *isAllowedRotation, bool *isAllowedScale, bool *isAllowedShear)
 Get the allowed transformations of the sheet element. More...
 
void GetMinNodeSize (std::vector< double > &sizeValues)
 Gets the minimum node size values
Created in NX11.0.0. More...
 
double Height ()
 Returns the height. More...
 
NXOpen::Diagramming::DiagrammingSizingpolicy HeightPolicy ()
 Returns the height policy. More...
 
bool Internal ()
 Returns the flag that indicates if the sheet element is internal. More...
 
NXOpen::Diagramming::AnnotationLabel ()
 Returns the label of this sheet element. More...
 
NXString LabelName ()
 Returns the label name of this sheet element. More...
 
NXOpen::Diagramming::LocationBuilderLocation ()
 Returns the location of the sheet element relative to another sheet element. More...
 
NXOpen::Diagramming::DiagrammingLocationstyle LocationStyle ()
 Returns the location style. More...
 
bool MirrorX ()
 Returns the sheet element to Mirror along the X axis. More...
 
bool MirrorY ()
 Returns the sheet element to Mirror along the Y axis. More...
 
NXOpen::Diagramming::SheetElementOwner ()
 Returns the owning sheet element. More...
 
NXOpen::Diagramming::SheetOwningSheet ()
 Returns the owning sheet. More...
 
NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType ResizeOption ()
 Returns the resize option of the sheet element
Created in NX11.0.0. More...
 
double Rotation ()
 Returns the rotation angle that is counter clockwise and relative to the owner. More...
 
void SetHeight (double height)
 Sets the height. More...
 
void SetHeightPolicy (NXOpen::Diagramming::DiagrammingSizingpolicy heightPolicy)
 Sets the height policy. More...
 
void SetLabelName (const NXString &labelname)
 Sets the label name of this sheet element. More...
 
void SetLabelName (const char *labelname)
 Sets the label name of this sheet element. More...
 
void SetLocationStyle (NXOpen::Diagramming::DiagrammingLocationstyle locationStyle)
 Sets the location style. More...
 
void SetMinNodeSize (const std::vector< double > &sizeValues)
 Sets the minimum node size values
Created in NX11.0.0. More...
 
void SetMirrorX (bool mirrorX)
 Sets the sheet element to Mirror along the X axis. More...
 
void SetMirrorY (bool mirrorY)
 Sets the sheet element to Mirror along the Y axis. More...
 
void SetOwner (NXOpen::Diagramming::SheetElement *owner)
 Sets the owning sheet element. More...
 
void SetOwningSheet (NXOpen::Diagramming::Sheet *owningSheet)
 Set the owning sheet when the sheet element is created. More...
 
void SetResizeOption (NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType resizeOption)
 Sets the resize option of the sheet element
Created in NX11.0.0. More...
 
void SetRotation (double angle)
 Sets the rotation angle that is counter clockwise and relative to the owner. More...
 
void SetWidth (double width)
 Sets the width. More...
 
void SetWidthPolicy (NXOpen::Diagramming::DiagrammingSizingpolicy widthPolicy)
 Sets the width policy. More...
 
void SetX (double x)
 Sets the absolute x coordinate. More...
 
void SetY (double y)
 Sets the absolute y coordinate. More...
 
void SetZDepth (int zDepth)
 Sets the Z depth. More...
 
NXOpen::Diagramming::SheetElementSourceElement ()
 Returns the source element that records which sheet element it is a copy of. More...
 
bool UpToDate ()
 Returns the flag that indicates if the sheet element is up to date. More...
 
bool Visible ()
 Returns the flag that indicates if the sheet element is visible. More...
 
double Width ()
 Returns the width. More...
 
NXOpen::Diagramming::DiagrammingSizingpolicy WidthPolicy ()
 Returns the width policy. More...
 
double X ()
 Returns the absolute x coordinate. More...
 
double Y ()
 Returns the absolute y coordinate. More...
 
int ZDepth ()
 Returns the Z depth. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::Diagramming::SheetElementBuilder
enum  ResizeOptionType {
  ResizeOptionTypeAnyDirection, ResizeOptionTypeOnAnchor, ResizeOptionTypeSameRatio, ResizeOptionTypeSameRationOnCorner,
  ResizeOptionTypeSameRatioOnEdge
}
 Represents the resize option for a NXOpen::Diagramming::SheetElementBuilder . More...
 

Detailed Description

Represents a NodeBuilder.


To create a new instance of this class, use NXOpen::Diagramming::NodeCollection::CreateNodeBuilder

Created in NX10.0.0.

Member Function Documentation

void NXOpen::Diagramming::NodeBuilder::AddGroupMember ( NXOpen::Diagramming::SheetElement member)

Adds a node to this node group.


Created in NX10.0.0.

License requirements : None

Parameters
membermember
bool NXOpen::Diagramming::NodeBuilder::Expanded ( )

Returns the node state of expanded or collapsed.

If true the node is expanded.
Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::NodeBuilder::Fullfillment ( )

Returns the flag that indicates if the node is a fulfillment object.

If true the node represents a physical object such as a piece of equipment from a library.
Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::NodeBuilder::GroupingAllowed ( )

Returns the flag that indicates if the node is allowed to be a nested node and contain other child sheet elements.


Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::Node* NXOpen::Diagramming::NodeBuilder::OffsheetReference ( )

Returns the referenced offsheet node.

It could be elsewhere on the same sheet or on a different sheet and it can be NULL.
Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::NodeBuilder::RemoveAllGroupMembers ( )

Remove all members.


Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::NodeBuilder::RemoveGroupMember ( NXOpen::Diagramming::SheetElement member)

Removes a node from this node group.


Created in NX10.0.0.

License requirements : None

Parameters
membermember
void NXOpen::Diagramming::NodeBuilder::SetExpanded ( bool  expanded)

Sets the node state of expanded or collapsed.

If true the node is expanded.
Created in NX10.0.0.

License requirements : None

Parameters
expandedexpanded
void NXOpen::Diagramming::NodeBuilder::SetGroupingAllowed ( bool  isGroupingAllowed)

Sets the flag that indicates if the node is allowed to be a nested node and contain other child sheet elements.


Created in NX10.0.0.

License requirements : None

Parameters
isGroupingAllowedisgroupingallowed
void NXOpen::Diagramming::NodeBuilder::SetOffsheetReference ( NXOpen::Diagramming::Node offsheetReference)

Sets the referenced offsheet node.

It could be elsewhere on the same sheet or on a different sheet and it can be NULL.
Created in NX10.0.0.

License requirements : None

Parameters
offsheetReferenceoffsheetreference

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