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

Represents a NXOpen::Display::Image
This class is restricted to being called from a program running during an Interactive NX session. More...

Inheritance diagram for NXOpen::Display::Image:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void ImageFileSelect ()
 Gets an image file using file selection. More...
 
void ImagePaletteSelect ()
 Gets an image file from the image palette. More...
 
bool ImagePreviewToggle ()
 Returns the image preview toggle
Created in NX6.0.0. More...
 
double PatternRepeatFactor ()
 Returns the pattern repeat factor - the number of times the image repeats; non integer patternRepeatFactor numbers result in partial repeats. More...
 
void SetImagePreviewToggle (bool imagePreviewToggle)
 Sets the image preview toggle
Created in NX6.0.0. More...
 
void SetPatternRepeatFactor (double patternRepeatFactor)
 Sets the pattern repeat factor - the number of times the image repeats; non integer patternRepeatFactor numbers result in partial repeats. 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 NXOpen::Display::Image
This class is restricted to being called from a program running during an Interactive NX session.

If run from a non-interactive session it will return NULL.

To create a new instance of this class, use NXOpen::ViewCollection::CreateImage

Created in NX5.0.0.

Member Function Documentation

void NXOpen::Display::Image::ImageFileSelect ( )

Gets an image file using file selection.


Created in NX5.0.0.

License requirements : None

void NXOpen::Display::Image::ImagePaletteSelect ( )

Gets an image file from the image palette.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Display::Image::ImagePreviewToggle ( )

Returns the image preview toggle
Created in NX6.0.0.



License requirements : None

double NXOpen::Display::Image::PatternRepeatFactor ( )

Returns the pattern repeat factor - the number of times the image repeats; non integer patternRepeatFactor numbers result in partial repeats.


Created in NX10.0.0.

License requirements : None

void NXOpen::Display::Image::SetImagePreviewToggle ( bool  imagePreviewToggle)

Sets the image preview toggle
Created in NX6.0.0.



License requirements : None

Parameters
imagePreviewToggleimagepreviewtoggle
void NXOpen::Display::Image::SetPatternRepeatFactor ( double  patternRepeatFactor)

Sets the pattern repeat factor - the number of times the image repeats; non integer patternRepeatFactor numbers result in partial repeats.


Created in NX10.0.0.

License requirements : None

Parameters
patternRepeatFactorpatternrepeatfactor

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