NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::HatchBuilder Class Reference

This class is used to construct the crosshatching that lies within a boundary. More...

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

List of all members.

Public Types

enum  AnnotationTypes { AnnotationTypesCrosshatch, AnnotationTypesAreaFill }
 Represents types of hatch objects. More...

Public Member Functions

double Angle ()
 Returns the angle.
NXOpen::SelectDisplayableObjectListAnnotationToExclude ()
 Returns the select annotation to exclude
Created in NX6.0.0.
NXOpen::Annotations::HatchBuilder::AnnotationTypes AnnotationType ()
 Returns the type of hatch object
Created in NX6.0.0.
double AreafillAngle ()
 Returns the areafill angle.
bool AutomaticallyExcludeText ()
 Returns the exclude text.
NXOpen::Annotations::BoundaryBuilderBoundary ()
 Returns the boundary
Created in NX6.0.0.
NXOpen::NXColorColor ()
 Returns the color.
NXString CrosshatchFile ()
 Returns the crosshatch file.
double Distance ()
 Returns the distance.
double GetMarginPercent (NXOpen::NXObject *annotation)
 Get margin percent of a annotation.
NXOpen::Annotations::HatchFillSettingsBuilderHatchFillSettings ()
 Returns the HatchFillSetting
Created in NX7.5.0.
NXOpen::Annotations::AreaFillMaterial Material ()
 Returns the area fill material.
NXString Pattern ()
 Returns the pattern.
double Scale ()
 Returns the scale.
void SetAngle (double angle)
 Sets the angle.
void SetAnnotationType (NXOpen::Annotations::HatchBuilder::AnnotationTypes type)
 Sets the type of hatch object
Created in NX6.0.0.
void SetAreafillAngle (double angle)
 Sets the areafill angle.
void SetAutomaticallyExcludeText (bool excludeText)
 Sets the exclude text.
void SetColor (NXOpen::NXColor *color)
 Sets the color.
void SetCrosshatchFile (const NXString &filename)
 Sets the crosshatch file.
void SetCurveDirection (NXOpen::NXObject *curveTag, int curveDirection)
 Set direction of a curve to the annotation The number of diection map elements need to specify before to the direction of the curve elements to the annotation
Created in NX8.0.0.
void SetDistance (double distance)
 Sets the distance.
void SetMarginPercent (NXOpen::NXObject *annotation, double marginpercent)
 Set margin percent to a annotation
Created in NX7.5.0.
void SetMaterial (NXOpen::Annotations::AreaFillMaterial areaFillMaterial)
 Sets the area fill material.
void SetNumCurrentDirectionMapElements (int numCurrentDirectionMapElement)
 Set number of direction map elements to the annotation
Created in NX8.0.0.
void SetPattern (const NXString &identifier)
 Sets the pattern.
void SetScale (double scale)
 Sets the scale.
void SetTolerance (double tolerance)
 Sets the tolerance.
void SetWidth (NXOpen::Annotations::LineWidth width)
 Sets the width.
double Tolerance ()
 Returns the tolerance.
NXOpen::Annotations::LineWidth Width ()
 Returns the width.

Detailed Description

This class is used to construct the crosshatching that lies within a boundary.


To create a new instance of this class, use Annotations::HatchCollection::CreateHatchBuilder

Created in NX6.0.0.


Member Enumeration Documentation

Represents types of hatch objects.

Use Annotations::HatchBuilder::HatchFillSettings instead..

Deprecated:
Deprecated in NX7.5.0.
Enumerator:
AnnotationTypesCrosshatch 

Crosshatch.

AnnotationTypesAreaFill 

Area Fill.


Member Function Documentation

Returns the angle.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : None

Returns the select annotation to exclude
Created in NX6.0.0.



License requirements : None

Returns the type of hatch object
Created in NX6.0.0.



License requirements : None

Returns the areafill angle.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.1.

License requirements : None

Returns the exclude text.

This is not used if Annotations::BoundaryBuilder::SelectionMethodCurves is set.
Created in NX6.0.0.

License requirements : None

Returns the boundary
Created in NX6.0.0.



License requirements : None

Returns the color.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : None

Returns the crosshatch file.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : None

Returns the distance.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : None

Get margin percent of a annotation.

Returns:

Created in NX7.5.0.

License requirements : None
Parameters:
annotationannotation or DraftingCombinedInstance

Returns the HatchFillSetting
Created in NX7.5.0.



License requirements : None

Returns the area fill material.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : None

Returns the pattern.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : None

Returns the scale.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : None

Sets the angle.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
angleangle

Sets the type of hatch object
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
typetype

Sets the areafill angle.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.1.

License requirements : drafting ("DRAFTING")

Parameters:
angleangle

Sets the exclude text.

This is not used if Annotations::BoundaryBuilder::SelectionMethodCurves is set.
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
excludeTextexcludetext

Sets the color.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
colorcolor

Sets the crosshatch file.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
filenamefilename
void NXOpen::Annotations::HatchBuilder::SetCurveDirection ( NXOpen::NXObject curveTag,
int  curveDirection 
)

Set direction of a curve to the annotation The number of diection map elements need to specify before to the direction of the curve elements to the annotation
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
curveTagcurvetag
curveDirectioncurvedirection

Sets the distance.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
distancedistance
void NXOpen::Annotations::HatchBuilder::SetMarginPercent ( NXOpen::NXObject annotation,
double  marginpercent 
)

Set margin percent to a annotation
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
annotationannotation or DraftingCombinedInstance
marginpercenttext islands value

Sets the area fill material.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
areaFillMaterialareafillmaterial
void NXOpen::Annotations::HatchBuilder::SetNumCurrentDirectionMapElements ( int  numCurrentDirectionMapElement)

Set number of direction map elements to the annotation
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
numCurrentDirectionMapElementnumcurrentdirectionmapelement

Sets the pattern.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
identifieridentifier

Sets the scale.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
scalescale

Sets the tolerance.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
tolerancetolerance

Sets the width.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
widthwidth

Returns the tolerance.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : None

Returns the width.

Use Annotations::HatchBuilder::HatchFillSettings instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.0.

License requirements : None


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