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

Represents a NXOpen::Annotations::HatchStyleBuilder . More...

Inheritance diagram for NXOpen::Annotations::HatchStyleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

double AreaFillAngle ()
 Returns the area fill angle
Created in NX6.0.0. More...
 
NXOpen::Annotations::AreaFillMaterial AreaFillMaterial ()
 Returns the area fill material
Created in NX6.0.0. More...
 
double AreaFillScale ()
 Returns the area fill scale
Created in NX6.0.0. More...
 
bool AutoTextIsland ()
 Returns the automatic text island creation flag. More...
 
NXOpen::NXColorColor ()
 Returns the color of crosshatch or area fill lines or area fill solid fill color
Created in NX6.0.0. More...
 
bool FindApparentIntersections ()
 Returns the Find Apparent Intersections creation flag. More...
 
double HatchAngle ()
 Returns the angle of the crosshatching lines
Created in NX6.0.0. More...
 
double HatchDistance ()
 Returns the distance between crosshatch lines
Created in NX6.0.0. More...
 
NXString HatchFile ()
 Returns the crosshatch definition file
Created in NX6.0.0. More...
 
NXString HatchMaterial ()
 Returns the crosshatch material
Created in NX6.0.0. More...
 
double IslandMargin ()
 Returns the Island margin
Created in NX9.0.0. More...
 
NXOpen::Annotations::LineWidth LineWidth ()
 Returns the line width for crosshatch lines
Created in NX6.0.0. More...
 
void SetAreaFillAngle (double areaFillAngle)
 Sets the area fill angle
Created in NX6.0.0. More...
 
void SetAreaFillMaterial (NXOpen::Annotations::AreaFillMaterial areaFillMaterial)
 Sets the area fill material
Created in NX6.0.0. More...
 
void SetAreaFillScale (double areaFillScale)
 Sets the area fill scale
Created in NX6.0.0. More...
 
void SetAutoTextIsland (bool autoTextIsland)
 Sets the automatic text island creation flag. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the color of crosshatch or area fill lines or area fill solid fill color
Created in NX6.0.0. More...
 
void SetFindApparentIntersections (bool findApparentIntersections)
 Sets the Find Apparent Intersections creation flag. More...
 
void SetHatchAngle (double angle)
 Sets the angle of the crosshatching lines
Created in NX6.0.0. More...
 
void SetHatchDistance (double distance)
 Sets the distance between crosshatch lines
Created in NX6.0.0. More...
 
void SetHatchFile (const NXString &file)
 Sets the crosshatch definition file
Created in NX6.0.0. More...
 
void SetHatchFile (const char *file)
 Sets the crosshatch definition file
Created in NX6.0.0. More...
 
void SetHatchMaterial (const NXString &material)
 Sets the crosshatch material
Created in NX6.0.0. More...
 
void SetHatchMaterial (const char *material)
 Sets the crosshatch material
Created in NX6.0.0. More...
 
void SetIslandMargin (double islandMargin)
 Sets the Island margin
Created in NX9.0.0. More...
 
void SetLineWidth (NXOpen::Annotations::LineWidth lineWidth)
 Sets the line width for crosshatch lines
Created in NX6.0.0. More...
 
void SetTolerance (double tolerance)
 Sets the crosshatch and area fill tolerance
Created in NX6.0.0. More...
 
double Tolerance ()
 Returns the crosshatch and area fill tolerance
Created in NX6.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::HatchStyleBuilder .

This class queries and sets crosshatching and area fill preferences when creating and editing crosshatching and area fill drafting annotations.


Created in NX6.0.0.

Member Function Documentation

double NXOpen::Annotations::HatchStyleBuilder::AreaFillAngle ( )

Returns the area fill angle
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::AreaFillMaterial NXOpen::Annotations::HatchStyleBuilder::AreaFillMaterial ( )

Returns the area fill material
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::HatchStyleBuilder::AreaFillScale ( )

Returns the area fill scale
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::HatchStyleBuilder::AutoTextIsland ( )

Returns the automatic text island creation flag.

A value of True means a text island will be created when the crosshatch or area fill is created
Created in NX6.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::Annotations::HatchStyleBuilder::Color ( )

Returns the color of crosshatch or area fill lines or area fill solid fill color
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::HatchStyleBuilder::FindApparentIntersections ( )

Returns the Find Apparent Intersections creation flag.


Created in NX9.0.0.

License requirements : None

double NXOpen::Annotations::HatchStyleBuilder::HatchAngle ( )

Returns the angle of the crosshatching lines
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::HatchStyleBuilder::HatchDistance ( )

Returns the distance between crosshatch lines
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::HatchStyleBuilder::HatchFile ( )

Returns the crosshatch definition file
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::HatchStyleBuilder::HatchMaterial ( )

Returns the crosshatch material
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::HatchStyleBuilder::IslandMargin ( )

Returns the Island margin
Created in NX9.0.0.



License requirements : None

NXOpen::Annotations::LineWidth NXOpen::Annotations::HatchStyleBuilder::LineWidth ( )

Returns the line width for crosshatch lines
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::HatchStyleBuilder::SetAreaFillAngle ( double  areaFillAngle)

Sets the area fill angle
Created in NX6.0.0.



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

Parameters
areaFillAngleareafillangle
void NXOpen::Annotations::HatchStyleBuilder::SetAreaFillMaterial ( NXOpen::Annotations::AreaFillMaterial  areaFillMaterial)

Sets the area fill material
Created in NX6.0.0.



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

Parameters
areaFillMaterialareafillmaterial
void NXOpen::Annotations::HatchStyleBuilder::SetAreaFillScale ( double  areaFillScale)

Sets the area fill scale
Created in NX6.0.0.



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

Parameters
areaFillScaleareafillscale
void NXOpen::Annotations::HatchStyleBuilder::SetAutoTextIsland ( bool  autoTextIsland)

Sets the automatic text island creation flag.

A value of True means a text island will be created when the crosshatch or area fill is created
Created in NX6.0.0.

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

Parameters
autoTextIslandautotextisland
void NXOpen::Annotations::HatchStyleBuilder::SetColor ( NXOpen::NXColor color)

Sets the color of crosshatch or area fill lines or area fill solid fill color
Created in NX6.0.0.



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

Parameters
colorcolor
void NXOpen::Annotations::HatchStyleBuilder::SetFindApparentIntersections ( bool  findApparentIntersections)

Sets the Find Apparent Intersections creation flag.


Created in NX9.0.0.

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

Parameters
findApparentIntersectionsfindapparentintersections
void NXOpen::Annotations::HatchStyleBuilder::SetHatchAngle ( double  angle)

Sets the angle of the crosshatching lines
Created in NX6.0.0.



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

Parameters
angleangle
void NXOpen::Annotations::HatchStyleBuilder::SetHatchDistance ( double  distance)

Sets the distance between crosshatch lines
Created in NX6.0.0.



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

Parameters
distancedistance
void NXOpen::Annotations::HatchStyleBuilder::SetHatchFile ( const NXString file)

Sets the crosshatch definition file
Created in NX6.0.0.



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

Parameters
filefile
void NXOpen::Annotations::HatchStyleBuilder::SetHatchFile ( const char *  file)

Sets the crosshatch definition file
Created in NX6.0.0.



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

Parameters
filefile
void NXOpen::Annotations::HatchStyleBuilder::SetHatchMaterial ( const NXString material)

Sets the crosshatch material
Created in NX6.0.0.



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

Parameters
materialmaterial
void NXOpen::Annotations::HatchStyleBuilder::SetHatchMaterial ( const char *  material)

Sets the crosshatch material
Created in NX6.0.0.



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

Parameters
materialmaterial
void NXOpen::Annotations::HatchStyleBuilder::SetIslandMargin ( double  islandMargin)

Sets the Island margin
Created in NX9.0.0.



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

Parameters
islandMarginislandmargin
void NXOpen::Annotations::HatchStyleBuilder::SetLineWidth ( NXOpen::Annotations::LineWidth  lineWidth)

Sets the line width for crosshatch lines
Created in NX6.0.0.



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

Parameters
lineWidthlinewidth
void NXOpen::Annotations::HatchStyleBuilder::SetTolerance ( double  tolerance)

Sets the crosshatch and area fill tolerance
Created in NX6.0.0.



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

Parameters
tolerancetolerance
double NXOpen::Annotations::HatchStyleBuilder::Tolerance ( )

Returns the crosshatch and area fill tolerance
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::Annotations::HatchStyleBuilder::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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.