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:

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

Public Member Functions
double	Angle ()
	Returns the angle. More...
NXOpen::SelectDisplayableObjectList *	AnnotationToExclude ()
	Returns the select annotation to exclude Created in NX6.0.0. More...
NXOpen::Annotations::HatchBuilder::AnnotationTypes	AnnotationType ()
	Returns the type of hatch object Created in NX6.0.0. More...
double	AreafillAngle ()
	Returns the areafill angle. More...
bool	AutomaticallyExcludeText ()
	Returns the exclude text. More...
NXOpen::Annotations::BoundaryBuilder *	Boundary ()
	Returns the boundary Created in NX6.0.0. More...
NXOpen::NXColor *	Color ()
	Returns the color. More...
NXString	CrosshatchFile ()
	Returns the crosshatch file. More...
double	Distance ()
	Returns the distance. More...
double	GetMarginPercent (NXOpen::NXObject *annotation)
	Get margin percent of a annotation. More...
NXOpen::Annotations::HatchFillSettingsBuilder *	HatchFillSettings ()
	Returns the HatchFillSetting Created in NX7.5.0. More...
NXOpen::Annotations::AreaFillMaterial	Material ()
	Returns the area fill material. More...
NXString	Pattern ()
	Returns the pattern. More...
double	Scale ()
	Returns the scale. More...
void	SetAngle (double angle)
	Sets the angle. More...
void	SetAnnotationType (NXOpen::Annotations::HatchBuilder::AnnotationTypes type)
	Sets the type of hatch object Created in NX6.0.0. More...
void	SetAreafillAngle (double angle)
	Sets the areafill angle. More...
void	SetAutomaticallyExcludeText (bool excludeText)
	Sets the exclude text. More...
void	SetColor (NXOpen::NXColor *color)
	Sets the color. More...
void	SetCrosshatchFile (const NXString &filename)
	Sets the crosshatch file. More...
void	SetCrosshatchFile (const char *filename)
	Sets the crosshatch file. More...
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. More...
void	SetDistance (double distance)
	Sets the distance. More...
void	SetMarginPercent (NXOpen::NXObject *annotation, double marginpercent)
	Set margin percent to a annotation Created in NX7.5.0. More...
void	SetMaterial (NXOpen::Annotations::AreaFillMaterial areaFillMaterial)
	Sets the area fill material. More...
void	SetNumCurrentDirectionMapElements (int numCurrentDirectionMapElement)
	Set number of direction map elements to the annotation Created in NX8.0.0. More...
void	SetPattern (const NXString &identifier)
	Sets the pattern. More...
void	SetPattern (const char *identifier)
	Sets the pattern. More...
void	SetScale (double scale)
	Sets the scale. More...
void	SetSectionCurveDirections (NXOpen::NXObject *section, NXOpen::NXObject *curve, const std::vector< int > &curveDirections)
	Set directions 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.5.0. More...
void	SetTolerance (double tolerance)
	Sets the tolerance. More...
void	SetWidth (NXOpen::Annotations::LineWidth width)
	Sets the width. More...
double	Tolerance ()
	Returns the tolerance. More...
NXOpen::Annotations::LineWidth	Width ()
	Returns the width. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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

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

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

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::HatchBuilder::AnnotationTypes

Represents types of hatch objects.

Use NXOpen::Annotations::HatchBuilder::HatchFillSettings instead..

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchBuilder::HatchFillSettings instead.

Enumerator
AnnotationTypesCrosshatch	Crosshatch.
AnnotationTypesAreaFill	Area Fill.

Member Function Documentation

double NXOpen::Annotations::HatchBuilder::Angle

(

)

Returns the angle.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Annotations::HatchBuilder::AnnotationToExclude

(

)

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

License requirements : None

NXOpen::Annotations::HatchBuilder::AnnotationTypes NXOpen::Annotations::HatchBuilder::AnnotationType

(

)

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

License requirements : None

double NXOpen::Annotations::HatchBuilder::AreafillAngle

(

)

Returns the areafill angle.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.1.

License requirements : None

bool NXOpen::Annotations::HatchBuilder::AutomaticallyExcludeText

(

)

Returns the exclude text.

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

License requirements : None

NXOpen::Annotations::BoundaryBuilder* NXOpen::Annotations::HatchBuilder::Boundary

(

)

Returns the boundary
Created in NX6.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::Annotations::HatchBuilder::Color

(

)

Returns the color.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : None

NXString NXOpen::Annotations::HatchBuilder::CrosshatchFile

(

)

Returns the crosshatch file.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::HatchBuilder::Distance

(

)

Returns the distance.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::HatchBuilder::GetMarginPercent

(

NXOpen::NXObject *

annotation

)

Get margin percent of a annotation.

Returns

Created in NX7.5.0.

License requirements : None

Parameters

annotation

annotation or DraftingCombinedInstance

NXOpen::Annotations::HatchFillSettingsBuilder* NXOpen::Annotations::HatchBuilder::HatchFillSettings

(

)

Returns the HatchFillSetting
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::AreaFillMaterial NXOpen::Annotations::HatchBuilder::Material

(

)

Returns the area fill material.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : None

NXString NXOpen::Annotations::HatchBuilder::Pattern

(

)

Returns the pattern.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::HatchBuilder::Scale

(

)

Returns the scale.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : None

void NXOpen::Annotations::HatchBuilder::SetAngle

(

double

angle

)

Sets the angle.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

angle

angle

void NXOpen::Annotations::HatchBuilder::SetAnnotationType

(

NXOpen::Annotations::HatchBuilder::AnnotationTypes

type

)

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

License requirements : drafting ("DRAFTING")

Parameters

type

type

void NXOpen::Annotations::HatchBuilder::SetAreafillAngle

(

double

angle

)

Sets the areafill angle.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.1.

License requirements : drafting ("DRAFTING")

Parameters

angle

angle

void NXOpen::Annotations::HatchBuilder::SetAutomaticallyExcludeText

(

bool

excludeText

)

Sets the exclude text.

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

License requirements : drafting ("DRAFTING")

Parameters

excludeText

excludetext

void NXOpen::Annotations::HatchBuilder::SetColor

(

NXOpen::NXColor *

color

)

Sets the color.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

color

color

void NXOpen::Annotations::HatchBuilder::SetCrosshatchFile

(

const NXString &

filename

)

Sets the crosshatch file.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

filename

filename

void NXOpen::Annotations::HatchBuilder::SetCrosshatchFile

(

const char *

filename

)

Sets the crosshatch file.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

filename

filename

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

curveTag	curvetag
curveDirection	curvedirection

void NXOpen::Annotations::HatchBuilder::SetDistance

(

double

distance

)

Sets the distance.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

distance

distance

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

annotation	annotation or DraftingCombinedInstance
marginpercent	text islands value

void NXOpen::Annotations::HatchBuilder::SetMaterial

(

NXOpen::Annotations::AreaFillMaterial

areaFillMaterial

)

Sets the area fill material.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

areaFillMaterial

areafillmaterial

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

numCurrentDirectionMapElement

numcurrentdirectionmapelement

void NXOpen::Annotations::HatchBuilder::SetPattern

(

const NXString &

identifier

)

Sets the pattern.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

identifier

identifier

void NXOpen::Annotations::HatchBuilder::SetPattern

(

const char *

identifier

)

Sets the pattern.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

identifier

identifier

void NXOpen::Annotations::HatchBuilder::SetScale

(

double

scale

)

Sets the scale.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

scale

scale

void NXOpen::Annotations::HatchBuilder::SetSectionCurveDirections	(	NXOpen::NXObject *	section,
		NXOpen::NXObject *	curve,
		const std::vector< int > &	curveDirections
	)

Set directions 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.5.0.

License requirements : drafting ("DRAFTING")

Parameters

section	section
curve	curve
curveDirections	array of directions for the curve

void NXOpen::Annotations::HatchBuilder::SetTolerance

(

double

tolerance

)

Sets the tolerance.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

tolerance

tolerance

void NXOpen::Annotations::HatchBuilder::SetWidth

(

NXOpen::Annotations::LineWidth

width

)

Sets the width.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Parameters

width

width

double NXOpen::Annotations::HatchBuilder::Tolerance

(

)

Returns the tolerance.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::LineWidth NXOpen::Annotations::HatchBuilder::Width

(

)

Returns the width.

Deprecated:

Deprecated in NX7.5.0. Use NXOpen::Annotations::HatchFillSettingsBuilder instead.

Created in NX6.0.0.

License requirements : None

---

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

• Annotations_HatchBuilder.hxx