NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Annotations.CuttingPlaneSymbolBuilder Class Reference

Represents a NXOpen.Annotations.CuttingPlaneSymbolBuilder More...

Inheritance diagram for NXOpen.Annotations.CuttingPlaneSymbolBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ArrowDirectionOption { Towards, Away }
 Represents position of the arrow direction relative to cutting plane More...
 
enum  TextPlaneRelativeArrow { Parallel, Perpendicular }
 Represents position of the text relative to the arrow option More...
 
enum  ViewNameFormatOption { UserDefined, A, AA }
 Represents whether the view name is derived from the PMI cutting plane symbol text. More...
 

Public Member Functions

unsafe void AlternateArrow ()
 The Cutting Plane Symbol Alternate Arrow More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Annotations.CuttingPlaneSymbolBuilder.ArrowDirectionOption 
ArrowDirection [get, set]
 Returns or sets the Cutting Plane Symbol Arrow Direction relative to plane More...
 
unsafe double ArrowLength [get, set]
 Returns or sets the Cutting Plane Symbol Arrow Length More...
 
unsafe int Color [get, set]
 Returns or sets the color of the Cutting Plane Symbol More...
 
unsafe string CuttingPlaneSymbolText [get, set]
 Returns or sets the Cutting Plane Symbol text More...
 
unsafe bool DisplayCuttingPlaneSymbol [get, set]
 Returns or sets the display cutting plane symbol More...
 
unsafe NXOpen.LineFontBuilder Font [get]
 Returns the font More...
 
unsafe bool ShadedPlane [get, set]
 Returns or sets the shaded plane More...
 
unsafe
NXOpen.Annotations.StyleBuilder 
Style [get]
 Returns the Cutting Plane Symbol Style More...
 
unsafe
NXOpen.Annotations.CuttingPlaneSymbolBuilder.TextPlaneRelativeArrow 
TextPlaneRelativeToArrow [get, set]
 Returns or sets the text plane relative to arrow More...
 
unsafe bool UseTwoArrows [get, set]
 Returns or sets the use two arrows More...
 
unsafe
NXOpen.Annotations.CuttingPlaneSymbolBuilder.ViewNameFormatOption 
ViewNameFormat [get, set]
 Returns or sets the name view from symbol More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Annotations.CuttingPlaneSymbolBuilder

This is a sub-builder class and cannot be directly instantiated

Created in NX9.0.0

Member Enumeration Documentation

Represents position of the arrow direction relative to cutting plane

Enumerator
Towards 

The Direction of the PMI Cutting Plane Symbol Arrow Towards Plane.

Away 

The Direction of the PMI Cutting Plane Symbol Arrow Away From Plane.

Represents position of the text relative to the arrow option

Enumerator
Parallel 

The Plane of the PMI Cutting Plane Symbol Text is Parallel to its Arrow.

Perpendicular 

The Plane of the PMI Cutting Plane Symbol Text is Perpendicular to its Arrow.

Represents whether the view name is derived from the PMI cutting plane symbol text.

Enumerator
UserDefined 

User Defined View Name

A 

View Name is in the 'Section Prefix A' format, Where Section Prefix is taken from PMI Preferences and A is the Text of the PMI Cutting Plane Symbol.

AA 

View Name is in the 'Section Prefix A-A' format, Where Where Section Prefix is taken from PMI Preferences and A is the Text of the PMI Cutting Plane Symbol.

Member Function Documentation

unsafe void NXOpen.Annotations.CuttingPlaneSymbolBuilder.AlternateArrow ( )
inline

The Cutting Plane Symbol Alternate Arrow

Created in NX9.0.0

License requirements: None.

unsafe bool NXOpen.Annotations.CuttingPlaneSymbolBuilder.Validate ( )
inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Annotations.CuttingPlaneSymbolBuilder.ArrowDirectionOption NXOpen.Annotations.CuttingPlaneSymbolBuilder.ArrowDirection
getset

Returns or sets the Cutting Plane Symbol Arrow Direction relative to plane

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe double NXOpen.Annotations.CuttingPlaneSymbolBuilder.ArrowLength
getset

Returns or sets the Cutting Plane Symbol Arrow Length

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe int NXOpen.Annotations.CuttingPlaneSymbolBuilder.Color
getset

Returns or sets the color of the Cutting Plane Symbol

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe string NXOpen.Annotations.CuttingPlaneSymbolBuilder.CuttingPlaneSymbolText
getset

Returns or sets the Cutting Plane Symbol text

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe bool NXOpen.Annotations.CuttingPlaneSymbolBuilder.DisplayCuttingPlaneSymbol
getset

Returns or sets the display cutting plane symbol

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe NXOpen.LineFontBuilder NXOpen.Annotations.CuttingPlaneSymbolBuilder.Font
get

Returns the font

Created in NX9.0.0

License requirements: None.

unsafe bool NXOpen.Annotations.CuttingPlaneSymbolBuilder.ShadedPlane
getset

Returns or sets the shaded plane

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe NXOpen.Annotations.StyleBuilder NXOpen.Annotations.CuttingPlaneSymbolBuilder.Style
get

Returns the Cutting Plane Symbol Style

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Annotations.CuttingPlaneSymbolBuilder.TextPlaneRelativeArrow NXOpen.Annotations.CuttingPlaneSymbolBuilder.TextPlaneRelativeToArrow
getset

Returns or sets the text plane relative to arrow

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe bool NXOpen.Annotations.CuttingPlaneSymbolBuilder.UseTwoArrows
getset

Returns or sets the use two arrows

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe NXOpen.Annotations.CuttingPlaneSymbolBuilder.ViewNameFormatOption NXOpen.Annotations.CuttingPlaneSymbolBuilder.ViewNameFormat
getset

Returns or sets the name view from symbol

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")


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