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

Represents a Reflection Analysis builder. More...

Inheritance diagram for NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ImageMovementTypes { ImageMovementTypesHorizontal, ImageMovementTypesVertical, ImageMovementTypesRotate }
 The type of image movement. More...
 
enum  ImageSizeOption { ImageSizeOptionKeepCurrent, ImageSizeOptionReduceScale }
 The reflection image size option. More...
 
enum  LineImageTypes { LineImageTypesBlackLines, LineImageTypesBlackandWhiteLines, LineImageTypesColoredLines }
 The line image types. More...
 
enum  LineOrientationType { LineOrientationTypeHorizontal, LineOrientationTypeVertical, LineOrientationTypeBoth }
 The reflection line orientation. More...
 
enum  LineThicknessType { LineThicknessTypeThin, LineThicknessTypeNormal, LineThicknessTypeThick }
 The reflection line thickness. More...
 
enum  NumberOfLinesOptions {
  NumberOfLinesOptionsOne, NumberOfLinesOptionsTwo, NumberOfLinesOptionsFour, NumberOfLinesOptionsEight,
  NumberOfLinesOptionsSixteen, NumberOfLinesOptionsThirtyTwo, NumberOfLinesOptionsSixtyFour, NumberOfLinesOptionsOneTwoEight,
  NumberOfLinesOptionsTwoFiveSix
}
 The number of reflection lines. More...
 
enum  SceneImageType {
  SceneImageTypeSimulatedHorizon, SceneImageTypePhotoHorizon, SceneImageTypeSphericalRoom, SceneImageTypeSphericalLightTubesRoom,
  SceneImageTypeDaytimeHorizon, SceneImageTypeMagentaSunset, SceneImageTypeSphericalHorizon, SceneImageTypeCylindricalRoom,
  SceneImageTypeMonochromeHorizon, SceneImageTypeSmoothGrayScale, SceneImageTypeSharpGrayScale, SceneImageTypeSphericalTubes
}
 The reflection scene images. More...
 
enum  Types { TypesLineImages, TypesSceneImages, TypesImageFromFile }
 The types of images. More...
 

Public Member Functions

NXOpen::GeometricUtilities::DisplayResolutionBuilderDisplayResolution ()
 Returns the display resolution. More...
 
int FaceReflectivityScale ()
 Returns the face reflectivity scale from 0 to 100. More...
 
NXOpen::SelectDisplayableObjectListFaces ()
 Returns the face to apply reflection analysis. More...
 
NXString FileName ()
 Returns the file browser. More...
 
NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageMovementTypes ImageMovementType ()
 Returns the orientation to move reflection lines. More...
 
int ImagePosition ()
 Returns the moving image scale. More...
 
NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageSizeOption ImageSizeSetting ()
 Returns the image size setting. More...
 
NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineImageTypes LineImageType ()
 Returns the image type. More...
 
NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::NumberOfLinesOptions LineNumber ()
 Returns the reflection line number. More...
 
NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineOrientationType LineOrientation ()
 Returns the reflection line orientation. More...
 
NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineThicknessType LineThickness ()
 Returns the reflection line thickness. More...
 
NXOpen::GeometricAnalysis::FaceAnalysisNormalsBuilderNormals ()
 Returns the reflection analysis normals. More...
 
NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SceneImageType SceneImageOption ()
 Returns the scene image option. More...
 
void SetFaceReflectivityScale (int faceReflectivityScale)
 Sets the face reflectivity scale from 0 to 100. More...
 
void SetFileName (const NXString &filename)
 Sets the file browser. More...
 
void SetFileName (const char *filename)
 Sets the file browser. More...
 
void SetImageMovementType (NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageMovementTypes imageMovementType)
 Sets the orientation to move reflection lines. More...
 
void SetImagePosition (int imagePosition)
 Sets the moving image scale. More...
 
void SetImageSizeSetting (NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageSizeOption imageSizeSetting)
 Sets the image size setting. More...
 
void SetLineImageType (NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineImageTypes lineImageType)
 Sets the image type. More...
 
void SetLineNumber (NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::NumberOfLinesOptions lineNumber)
 Sets the reflection line number. More...
 
void SetLineOrientation (NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineOrientationType lineOrientation)
 Sets the reflection line orientation. More...
 
void SetLineThickness (NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineThicknessType lineThickness)
 Sets the reflection line thickness. More...
 
void SetSceneImageOption (NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SceneImageType sceneImageOption)
 Sets the scene image option. More...
 
void SetShowFacetEdge (bool showFacetEdge)
 Sets the flag indicating if facet edges should be shown. More...
 
void SetType (NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::Types type)
 Sets the reflection analysis type. More...
 
bool ShowFacetEdge ()
 Returns the flag indicating if facet edges should be shown. More...
 
void StartReflectionAnalysis ()
 Start reflection analysis. More...
 
NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::Types Type ()
 Returns the reflection analysis type. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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

Represents a Reflection Analysis builder.


To create a new instance of this class, use NXOpen::GeometricAnalysis::AnalysisObjectCollectionEx::CreateReflectionAnalysisBuilder
Default values.

Property Value

DisplayResolution.AngleTolerance

15.0

DisplayResolution.EdgeTolerance

0.005

DisplayResolution.FaceTolerance

0.005

DisplayResolution.Resolution

Standard

DisplayResolution.WidthTolerance

0.3

FaceReflectivityScale

100

ImagePosition

0

LineNumber

ThirtyTwo

ShowFacetEdge

0


Created in NX11.0.0.

Member Enumeration Documentation

The type of image movement.

Enumerator
ImageMovementTypesHorizontal 

Move image in horizonal direction.

ImageMovementTypesVertical 

Move image in vertical direction.

ImageMovementTypesRotate 

Rotate image.

The reflection image size option.

Enumerator
ImageSizeOptionKeepCurrent 

Keep current size.

ImageSizeOptionReduceScale 

Reduce scale size.

The line image types.

Enumerator
LineImageTypesBlackLines 

Black lines.

LineImageTypesBlackandWhiteLines 

Black and lines.

LineImageTypesColoredLines 

Colored lines.

The reflection line orientation.

Enumerator
LineOrientationTypeHorizontal 

Horizontal.

LineOrientationTypeVertical 

Vertical.

LineOrientationTypeBoth 

Both horizontal and vertical.

The reflection line thickness.

Enumerator
LineThicknessTypeThin 

Thin.

LineThicknessTypeNormal 

Normal.

LineThicknessTypeThick 

Thick.

The number of reflection lines.

Enumerator
NumberOfLinesOptionsOne 

1 reflection line.

NumberOfLinesOptionsTwo 

2 reflection line.

NumberOfLinesOptionsFour 

4 reflection line.

NumberOfLinesOptionsEight 

8 reflection line.

NumberOfLinesOptionsSixteen 

16 reflection line.

NumberOfLinesOptionsThirtyTwo 

32 reflection line.

NumberOfLinesOptionsSixtyFour 

64 reflection line.

NumberOfLinesOptionsOneTwoEight 

128 reflection line.

NumberOfLinesOptionsTwoFiveSix 

256 reflection line.

The reflection scene images.

Enumerator
SceneImageTypeSimulatedHorizon 

Simulated horizon.

SceneImageTypePhotoHorizon 

Photo horizon.

SceneImageTypeSphericalRoom 

Spherical room.

SceneImageTypeSphericalLightTubesRoom 

Spherical light tubes room.

SceneImageTypeDaytimeHorizon 

Daytime horizon.

SceneImageTypeMagentaSunset 

Magenta sunset.

SceneImageTypeSphericalHorizon 

Spherical horizon.

SceneImageTypeCylindricalRoom 

Cylindrical room.

SceneImageTypeMonochromeHorizon 

Monochrome horizon.

SceneImageTypeSmoothGrayScale 

Smooth gray scale.

SceneImageTypeSharpGrayScale 

Sharp gray scale.

SceneImageTypeSphericalTubes 

Spherical tubes.

The types of images.

Enumerator
TypesLineImages 

Line image.

TypesSceneImages 

Scene image.

TypesImageFromFile 

Image from file.

Member Function Documentation

NXOpen::GeometricUtilities::DisplayResolutionBuilder* NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::DisplayResolution ( )

Returns the display resolution.


Created in NX11.0.0.

License requirements : None

int NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::FaceReflectivityScale ( )

Returns the face reflectivity scale from 0 to 100.


Created in NX11.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::Faces ( )

Returns the face to apply reflection analysis.


Created in NX11.0.0.

License requirements : None

NXString NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::FileName ( )

Returns the file browser.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageMovementTypes NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageMovementType ( )

Returns the orientation to move reflection lines.


Created in NX11.0.0.

License requirements : None

int NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImagePosition ( )

Returns the moving image scale.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageSizeOption NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageSizeSetting ( )

Returns the image size setting.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineImageTypes NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineImageType ( )

Returns the image type.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::NumberOfLinesOptions NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineNumber ( )

Returns the reflection line number.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineOrientationType NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineOrientation ( )

Returns the reflection line orientation.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineThicknessType NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineThickness ( )

Returns the reflection line thickness.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::FaceAnalysisNormalsBuilder* NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::Normals ( )

Returns the reflection analysis normals.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SceneImageType NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SceneImageOption ( )

Returns the scene image option.


Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetFaceReflectivityScale ( int  faceReflectivityScale)

Sets the face reflectivity scale from 0 to 100.


Created in NX11.0.0.

License requirements : None

Parameters
faceReflectivityScalefacereflectivityscale
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetFileName ( const NXString filename)

Sets the file browser.


Created in NX11.0.0.

License requirements : None

Parameters
filenamefilename
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetFileName ( const char *  filename)

Sets the file browser.


Created in NX11.0.0.

License requirements : None

Parameters
filenamefilename
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetImageMovementType ( NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageMovementTypes  imageMovementType)

Sets the orientation to move reflection lines.


Created in NX11.0.0.

License requirements : None

Parameters
imageMovementTypeimagemovementtype
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetImagePosition ( int  imagePosition)

Sets the moving image scale.


Created in NX11.0.0.

License requirements : None

Parameters
imagePositionimageposition
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetImageSizeSetting ( NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ImageSizeOption  imageSizeSetting)

Sets the image size setting.


Created in NX11.0.0.

License requirements : None

Parameters
imageSizeSettingimagesizesetting
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetLineImageType ( NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineImageTypes  lineImageType)

Sets the image type.


Created in NX11.0.0.

License requirements : None

Parameters
lineImageTypelineimagetype
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetLineNumber ( NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::NumberOfLinesOptions  lineNumber)

Sets the reflection line number.


Created in NX11.0.0.

License requirements : None

Parameters
lineNumberlinenumber
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetLineOrientation ( NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineOrientationType  lineOrientation)

Sets the reflection line orientation.


Created in NX11.0.0.

License requirements : None

Parameters
lineOrientationlineorientation
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetLineThickness ( NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::LineThicknessType  lineThickness)

Sets the reflection line thickness.


Created in NX11.0.0.

License requirements : None

Parameters
lineThicknesslinethickness
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetSceneImageOption ( NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SceneImageType  sceneImageOption)

Sets the scene image option.


Created in NX11.0.0.

License requirements : None

Parameters
sceneImageOptionsceneimageoption
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetShowFacetEdge ( bool  showFacetEdge)

Sets the flag indicating if facet edges should be shown.


Created in NX11.0.0.

License requirements : None

Parameters
showFacetEdgeshowfacetedge
void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::SetType ( NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::Types  type)

Sets the reflection analysis type.


Created in NX11.0.0.

License requirements : None

Parameters
typetype
bool NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::ShowFacetEdge ( )

Returns the flag indicating if facet edges should be shown.


Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::StartReflectionAnalysis ( )

Start reflection analysis.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::Types NXOpen::GeometricAnalysis::ReflectionAnalysisBuilder::Type ( )

Returns the reflection analysis type.


Created in NX11.0.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.