NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder Class Reference

Represents a NXOpen.Annotations.PmiSectionViewCuttingPlaneSymbolBuilder. More...

Inheritance diagram for NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder:

Public Types
enum	ArrowDirectionOptions { ArrowDirectionOptionsTowardPlane, ArrowDirectionOptionsAwayfromPlane }
	The arrow direction options for cutting plane symbol. More...
enum	TextPlaneRelativeToArrowOptions { TextPlaneRelativeToArrowOptionsParallel, TextPlaneRelativeToArrowOptionsPerpendicular }
	The text plane relative to arrow options for cutting plane symbol. More...

Public Member Functions
NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ArrowDirectionOptions	ArrowDirection ()
	Returns the arrow direction for cutting plane symbol Created in NX1847.0.0. More...
double	ArrowLineLength ()
	Returns the arrow line length for cutting plane symbol Created in NX1847.0.0. More...
NXOpen::NXColor *	Color ()
	Returns the color for cutting plane symbol Created in NX1847.0.0. More...
NXString	SectionPrefix ()
	Returns the section prefix for cutting plane symbol Created in NX1847.0.0. More...
void	SetArrowDirection (NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ArrowDirectionOptions arrowDirection)
	Sets the arrow direction for cutting plane symbol Created in NX1847.0.0. More...
void	SetArrowLineLength (double arrowLineLength)
	Sets the arrow line length for cutting plane symbol Created in NX1847.0.0. More...
void	SetColor (NXOpen::NXColor *color)
	Sets the color for cutting plane symbol Created in NX1847.0.0. More...
void	SetSectionPrefix (const NXString &sectionPrefix)
	Sets the section prefix for cutting plane symbol Created in NX1847.0.0. More...
void	SetSectionPrefix (const char *sectionPrefix)
	Sets the section prefix for cutting plane symbol Created in NX1847.0.0. More...
void	SetShadedPlane (bool shadedPlane)
	Sets the shaded plane for cutting plane symbol Created in NX1847.0.0. More...
void	SetStartingLetter (const NXString &startingLetter)
	Sets the starting letter for cutting plane symbol Created in NX1847.0.0. More...
void	SetStartingLetter (const char *startingLetter)
	Sets the starting letter for cutting plane symbol Created in NX1847.0.0. More...
void	SetTextPlaneRelativeToArrow (NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::TextPlaneRelativeToArrowOptions textPlaneRelativeToArrow)
	Sets the text plane relative to arrow option for cutting plane symbol Created in NX1847.0.0. More...
bool	ShadedPlane ()
	Returns the shaded plane for cutting plane symbol Created in NX1847.0.0. More...
NXString	StartingLetter ()
	Returns the starting letter for cutting plane symbol Created in NX1847.0.0. More...
NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::TextPlaneRelativeToArrowOptions	TextPlaneRelativeToArrow ()
	Returns the text plane relative to arrow option for cutting plane symbol Created in NX1847.0.0. 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.PmiSectionViewCuttingPlaneSymbolBuilder.

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ArrowDirectionOptions

The arrow direction options for cutting plane symbol.

Enumerator
ArrowDirectionOptionsTowardPlane	toward plane
ArrowDirectionOptionsAwayfromPlane	away from plane

enum NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::TextPlaneRelativeToArrowOptions

The text plane relative to arrow options for cutting plane symbol.

Enumerator
TextPlaneRelativeToArrowOptionsParallel	parallel
TextPlaneRelativeToArrowOptionsPerpendicular	perpendicular

Member Function Documentation

NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ArrowDirectionOptions NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ArrowDirection

(

)

Returns the arrow direction for cutting plane symbol
Created in NX1847.0.0.

License requirements : None

double NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ArrowLineLength

(

)

Returns the arrow line length for cutting plane symbol
Created in NX1847.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::Color

(

)

Returns the color for cutting plane symbol
Created in NX1847.0.0.

License requirements : None

NXString NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SectionPrefix

(

)

Returns the section prefix for cutting plane symbol
Created in NX1847.0.0.

License requirements : None

void NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetArrowDirection

(

NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ArrowDirectionOptions

arrowDirection

)

Sets the arrow direction for cutting plane symbol
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

arrowDirection

arrowdirection

void NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetArrowLineLength

(

double

arrowLineLength

)

Sets the arrow line length for cutting plane symbol
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

arrowLineLength

arrowlinelength

void NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetColor

(

NXOpen::NXColor *

color

)

Sets the color for cutting plane symbol
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

color

color

void NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetSectionPrefix

(

const NXString &

sectionPrefix

)

Sets the section prefix for cutting plane symbol
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

sectionPrefix

sectionprefix

void NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetSectionPrefix

(

const char *

sectionPrefix

)

Sets the section prefix for cutting plane symbol
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

sectionPrefix

sectionprefix

void NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetShadedPlane

(

bool

shadedPlane

)

Sets the shaded plane for cutting plane symbol
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

shadedPlane

shadedplane

void NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetStartingLetter

(

const NXString &

startingLetter

)

Sets the starting letter for cutting plane symbol
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

startingLetter

startingletter

void NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetStartingLetter

(

const char *

startingLetter

)

Sets the starting letter for cutting plane symbol
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

startingLetter

startingletter

void NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetTextPlaneRelativeToArrow

(

NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::TextPlaneRelativeToArrowOptions

textPlaneRelativeToArrow

)

Sets the text plane relative to arrow option for cutting plane symbol
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

textPlaneRelativeToArrow

textplanerelativetoarrow

bool NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ShadedPlane

(

)

Returns the shaded plane for cutting plane symbol
Created in NX1847.0.0.

License requirements : None

NXString NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::StartingLetter

(

)

Returns the starting letter for cutting plane symbol
Created in NX1847.0.0.

License requirements : None

NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::TextPlaneRelativeToArrowOptions NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::TextPlaneRelativeToArrow

(

)

Returns the text plane relative to arrow option for cutting plane symbol
Created in NX1847.0.0.

License requirements : None

virtual bool NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

The documentation for this class was generated from the following file:

• Annotations_PmiSectionViewCuttingPlaneSymbolBuilder.hxx