NXOpen::PreviewPropertiesBuilder Class Reference

Represents a NXOpen::PreviewPropertiesBuilder to be used for creating and storing previews. More...

Inheritance diagram for NXOpen::PreviewPropertiesBuilder:

Public Types
enum	ModelViewCreationOptions { ModelViewCreationOptionsOnPartSave, ModelViewCreationOptionsOnViewSave, ModelViewCreationOptionsOnDemand }
	Specifies when the model view preview will be created. More...
enum	PartCreationOptions { PartCreationOptionsOnSave, PartCreationOptionsOnDemand }
	Specifies when the part preview will be created. More...

Public Member Functions
NXOpen::PreviewPropertiesBuilder::ModelViewCreationOptions	ModelViewCreation ()
	Returns the model view creation. More...
NXOpen::PreviewPropertiesBuilder::PartCreationOptions	PartCreation ()
	Returns the part creation. More...
NXOpen::SelectNXObjectList *	SelectedObjects ()
	Returns the selected object(s) list. More...
void	SetModelViewCreation (NXOpen::PreviewPropertiesBuilder::ModelViewCreationOptions modelViewCreation)
	Sets the model view creation. More...
void	SetPartCreation (NXOpen::PreviewPropertiesBuilder::PartCreationOptions partCreation)
	Sets the part creation. More...
void	SetStoreModelViewPreview (bool storeModelViewPreview)
	Sets the store model view preview. More...
void	SetStorePartPreview (bool storePartPreview)
	Sets the store part preview. More...
bool	StoreModelViewPreview ()
	Returns the store model view preview. More...
bool	StorePartPreview ()
	Returns the store part preview. 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

Represents a NXOpen::PreviewPropertiesBuilder to be used for creating and storing previews.

Both part previews and model view previews are supported.
To create a new instance of this class, use NXOpen::PropertiesManager::CreatePreviewPropertiesBuilder
Default values.

Property	Value
ModelViewCreation	OnPartSave
PartCreation	OnSave
StoreModelViewPreview	0
StorePartPreview	0

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::PreviewPropertiesBuilder::ModelViewCreationOptions

Specifies when the model view preview will be created.

Enumerator
ModelViewCreationOptionsOnPartSave	Model view preview will be created when the part is saved.
ModelViewCreationOptionsOnViewSave	Model view preview will be created when the view is saved.
ModelViewCreationOptionsOnDemand	Interactive only option that allows the model view preview to be created by selected the Create Now button.

enum NXOpen::PreviewPropertiesBuilder::PartCreationOptions

Specifies when the part preview will be created.

Enumerator
PartCreationOptionsOnSave	Part preview will be created when the part is saved.
PartCreationOptionsOnDemand	Interactive only option that allows the part preview to be created by selecting the Create Now button.

Member Function Documentation

NXOpen::PreviewPropertiesBuilder::ModelViewCreationOptions NXOpen::PreviewPropertiesBuilder::ModelViewCreation

(

)

Returns the model view creation.

This option determines when the model view preview will be stored. It is only used if the store model view preview is turned on.
Created in NX8.0.0.

License requirements : None

NXOpen::PreviewPropertiesBuilder::PartCreationOptions NXOpen::PreviewPropertiesBuilder::PartCreation

(

)

Returns the part creation.

This option determines when the part preview will be stored. It is only used if the store part preview is turned on.
Created in NX8.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::PreviewPropertiesBuilder::SelectedObjects

(

)

Returns the selected object(s) list.

Created in NX8.0.0.

License requirements : None

void NXOpen::PreviewPropertiesBuilder::SetModelViewCreation

(

NXOpen::PreviewPropertiesBuilder::ModelViewCreationOptions

modelViewCreation

)

Sets the model view creation.

This option determines when the model view preview will be stored. It is only used if the store model view preview is turned on.
Created in NX8.0.0.

License requirements : None

Parameters

modelViewCreation

modelviewcreation

void NXOpen::PreviewPropertiesBuilder::SetPartCreation

(

NXOpen::PreviewPropertiesBuilder::PartCreationOptions

partCreation

)

Sets the part creation.

This option determines when the part preview will be stored. It is only used if the store part preview is turned on.
Created in NX8.0.0.

License requirements : None

Parameters

partCreation

partcreation

void NXOpen::PreviewPropertiesBuilder::SetStoreModelViewPreview

(

bool

storeModelViewPreview

)

Sets the store model view preview.

Determines if the model view preview will be stored. If true, the model view creation option will decide when the preview will be stored.
Created in NX8.0.0.

License requirements : None

Parameters

storeModelViewPreview

storemodelviewpreview

void NXOpen::PreviewPropertiesBuilder::SetStorePartPreview

(

bool

storePartPreview

)

Sets the store part preview.

Determines if the part preview will be stored. If true, the part creation option will decide when the preview will be stored.
Created in NX8.0.0.

License requirements : None

Parameters

storePartPreview

storepartpreview

bool NXOpen::PreviewPropertiesBuilder::StoreModelViewPreview

(

)

Returns the store model view preview.

Determines if the model view preview will be stored. If true, the model view creation option will decide when the preview will be stored.
Created in NX8.0.0.

License requirements : None

bool NXOpen::PreviewPropertiesBuilder::StorePartPreview

(

)

Returns the store part preview.

Determines if the part preview will be stored. If true, the part creation option will decide when the preview will be stored.
Created in NX8.0.0.

License requirements : None

---

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

• PreviewPropertiesBuilder.hxx