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

This class is used to construct the Crosshatch and area Fill setting block . More...

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

Public Types

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

Public Member Functions

double Angle ()
 Returns the angle
Created in NX7.5.0. More...
 
NXOpen::Annotations::HatchFillSettingsBuilder::AnnotationTypes AnnotationType ()
 Returns the type of hatch object
Created in NX7.5.0. More...
 
bool ApplyToAllFromSameComp ()
 Returns the state to set this crosshatch settings to all same component crosshatches. More...
 
double AreafillAngle ()
 Returns the areafill angle
Created in NX6.0.1. More...
 
NXOpen::NXColorColor ()
 Returns the color
Created in NX7.5.0. More...
 
NXString CrosshatchFile ()
 Returns the crosshatch file
Created in NX7.5.0. More...
 
double Distance ()
 Returns the distance
Created in NX7.5.0. More...
 
NXString FindCrosshatchFile (const NXString &identifier)
 Finds the crosshatch file from pattern. More...
 
NXString FindCrosshatchFile (const char *identifier)
 Finds the crosshatch file from pattern. More...
 
NXOpen::Annotations::AreaFillMaterial Material ()
 Returns the area fill material
Created in NX7.5.0. More...
 
NXString Pattern ()
 Returns the pattern
Created in NX7.5.0. More...
 
double Scale ()
 Returns the scale
Created in NX6.0.0. More...
 
void SetAngle (double angle)
 Sets the angle
Created in NX7.5.0. More...
 
void SetAnnotationType (NXOpen::Annotations::HatchFillSettingsBuilder::AnnotationTypes type)
 Sets the type of hatch object
Created in NX7.5.0. More...
 
void SetApplyToAllFromSameComp (bool applyOnAllView)
 Sets the state to set this crosshatch settings to all same component crosshatches. More...
 
void SetAreafillAngle (double angle)
 Sets the areafill angle
Created in NX6.0.1. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the color
Created in NX7.5.0. More...
 
void SetCrosshatchFile (const NXString &filename)
 Sets the crosshatch file
Created in NX7.5.0. More...
 
void SetCrosshatchFile (const char *filename)
 Sets the crosshatch file
Created in NX7.5.0. More...
 
void SetDistance (double distance)
 Sets the distance
Created in NX7.5.0. More...
 
void SetMaterial (NXOpen::Annotations::AreaFillMaterial areaFillMaterial)
 Sets the area fill material
Created in NX7.5.0. More...
 
void SetPattern (const NXString &identifier)
 Sets the pattern
Created in NX7.5.0. More...
 
void SetPattern (const char *identifier)
 Sets the pattern
Created in NX7.5.0. More...
 
void SetScale (double scale)
 Sets the scale
Created in NX6.0.0. More...
 
void SetTolerance (double tolerance)
 Sets the tolerance
Created in NX7.5.0. More...
 
void SetWidth (NXOpen::Annotations::LineWidth width)
 Sets the width
Created in NX6.0.0. More...
 
double Tolerance ()
 Returns the tolerance
Created in NX7.5.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
NXOpen::Annotations::LineWidth Width ()
 Returns the width
Created in NX7.5.0. 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 Crosshatch and area Fill setting block .


Created in NX7.5.0.

Member Enumeration Documentation

the valid types of hatch objects

Enumerator
AnnotationTypesCrosshatch 

Crosshatch.

AnnotationTypesAreaFill 

Area Fill.

Member Function Documentation

double NXOpen::Annotations::HatchFillSettingsBuilder::Angle ( )

Returns the angle
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::HatchFillSettingsBuilder::AnnotationTypes NXOpen::Annotations::HatchFillSettingsBuilder::AnnotationType ( )

Returns the type of hatch object
Created in NX7.5.0.



License requirements : None

bool NXOpen::Annotations::HatchFillSettingsBuilder::ApplyToAllFromSameComp ( )

Returns the state to set this crosshatch settings to all same component crosshatches.

If true, it applies crosshatch settings on all of the current cut faces from the same component in all section views. If false, it applies crosshatch settings on selected crosshatch.
Created in NX11.0.1.

License requirements : None

double NXOpen::Annotations::HatchFillSettingsBuilder::AreafillAngle ( )

Returns the areafill angle
Created in NX6.0.1.



License requirements : None

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

Returns the color
Created in NX7.5.0.



License requirements : None

NXString NXOpen::Annotations::HatchFillSettingsBuilder::CrosshatchFile ( )

Returns the crosshatch file
Created in NX7.5.0.



License requirements : None

double NXOpen::Annotations::HatchFillSettingsBuilder::Distance ( )

Returns the distance
Created in NX7.5.0.



License requirements : None

NXString NXOpen::Annotations::HatchFillSettingsBuilder::FindCrosshatchFile ( const NXString identifier)

Finds the crosshatch file from pattern.

May be blank if not found

Returns

Created in NX8.5.0.

License requirements : None
Parameters
identifieridentifier
NXString NXOpen::Annotations::HatchFillSettingsBuilder::FindCrosshatchFile ( const char *  identifier)

Finds the crosshatch file from pattern.

May be blank if not found

Returns

Created in NX8.5.0.

License requirements : None
Parameters
identifieridentifier
NXOpen::Annotations::AreaFillMaterial NXOpen::Annotations::HatchFillSettingsBuilder::Material ( )

Returns the area fill material
Created in NX7.5.0.



License requirements : None

NXString NXOpen::Annotations::HatchFillSettingsBuilder::Pattern ( )

Returns the pattern
Created in NX7.5.0.



License requirements : None

double NXOpen::Annotations::HatchFillSettingsBuilder::Scale ( )

Returns the scale
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::HatchFillSettingsBuilder::SetAngle ( double  angle)

Sets the angle
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
angleangle
void NXOpen::Annotations::HatchFillSettingsBuilder::SetAnnotationType ( NXOpen::Annotations::HatchFillSettingsBuilder::AnnotationTypes  type)

Sets the type of hatch object
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
typetype
void NXOpen::Annotations::HatchFillSettingsBuilder::SetApplyToAllFromSameComp ( bool  applyOnAllView)

Sets the state to set this crosshatch settings to all same component crosshatches.

If true, it applies crosshatch settings on all of the current cut faces from the same component in all section views. If false, it applies crosshatch settings on selected crosshatch.
Created in NX11.0.1.

License requirements : drafting ("DRAFTING")

Parameters
applyOnAllViewapplyonallview
void NXOpen::Annotations::HatchFillSettingsBuilder::SetAreafillAngle ( double  angle)

Sets the areafill angle
Created in NX6.0.1.



License requirements : drafting ("DRAFTING")

Parameters
angleangle
void NXOpen::Annotations::HatchFillSettingsBuilder::SetColor ( NXOpen::NXColor color)

Sets the color
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
colorcolor
void NXOpen::Annotations::HatchFillSettingsBuilder::SetCrosshatchFile ( const NXString filename)

Sets the crosshatch file
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
filenamefilename
void NXOpen::Annotations::HatchFillSettingsBuilder::SetCrosshatchFile ( const char *  filename)

Sets the crosshatch file
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
filenamefilename
void NXOpen::Annotations::HatchFillSettingsBuilder::SetDistance ( double  distance)

Sets the distance
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
distancedistance
void NXOpen::Annotations::HatchFillSettingsBuilder::SetMaterial ( NXOpen::Annotations::AreaFillMaterial  areaFillMaterial)

Sets the area fill material
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
areaFillMaterialareafillmaterial
void NXOpen::Annotations::HatchFillSettingsBuilder::SetPattern ( const NXString identifier)

Sets the pattern
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
identifieridentifier
void NXOpen::Annotations::HatchFillSettingsBuilder::SetPattern ( const char *  identifier)

Sets the pattern
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
identifieridentifier
void NXOpen::Annotations::HatchFillSettingsBuilder::SetScale ( double  scale)

Sets the scale
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
scalescale
void NXOpen::Annotations::HatchFillSettingsBuilder::SetTolerance ( double  tolerance)

Sets the tolerance
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
tolerancetolerance
void NXOpen::Annotations::HatchFillSettingsBuilder::SetWidth ( NXOpen::Annotations::LineWidth  width)

Sets the width
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
widthwidth
double NXOpen::Annotations::HatchFillSettingsBuilder::Tolerance ( )

Returns the tolerance
Created in NX7.5.0.



License requirements : None

virtual bool NXOpen::Annotations::HatchFillSettingsBuilder::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.

NXOpen::Annotations::LineWidth NXOpen::Annotations::HatchFillSettingsBuilder::Width ( )

Returns the width
Created in NX7.5.0.



License requirements : None


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