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

Represents a NXOpen::Features::FeatureReplayBuilder builder. More...

Inheritance diagram for NXOpen::Features::FeatureReplayBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void MakeFirstCurrent ()
 Makes the first feature of the work part current. More...
 
void MakeLastCurrent ()
 Makes the last feature of the work part current. More...
 
void MakeNextBooleanCurrent ()
 Makes the next boolean feature of the work part current. More...
 
void MakeNextCurrent ()
 Makes the next feature of the work part current. More...
 
void MakePreviousCurrent ()
 Makes the previous feature of the work part current. More...
 
void Pause ()
 Pauses feature replay. More...
 
void Play ()
 Starts feature replay. More...
 
int ReplayTimestampNumber ()
 Returns the replay timestamp number of feature. More...
 
double SecondsBetweenSteps ()
 Returns the delay in seconds between replay steps
Created in NX6.0.0. More...
 
void SetReplayTimestampNumber (int replayTimestampNumber)
 Sets the replay timestamp number of feature. More...
 
void SetSecondsBetweenSteps (double secondsBetweenSteps)
 Sets the delay in seconds between replay steps
Created in NX6.0.0. 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::Features::FeatureReplayBuilder builder.

NXOpen::Features::FeatureReplayBuilder is used to control the feature replay of a part. Using this class, one can make the first feature or the last feature current, and step through the features by making the next feature or previous feature current. This class also allows stepping to the next boolean feature or automatically replay to a given feature. If the feature to be replayed to, is more than the current feature, one can specify a delay (time interval in seconds) between the replay of each of the features to observe the part construction with interactive NX session. When interactive NX session is not running, there will be no display of objects / current features.
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateFeatureReplayBuilder
Default values.

Property Value

ReplayTimestampNumber

0

SecondsBetweenSteps

0


Created in NX6.0.0.

Member Function Documentation

void NXOpen::Features::FeatureReplayBuilder::MakeFirstCurrent ( )

Makes the first feature of the work part current.

If replay is going on, it will stop.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Features::FeatureReplayBuilder::MakeLastCurrent ( )

Makes the last feature of the work part current.

If replay is going on, it will stop.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Features::FeatureReplayBuilder::MakeNextBooleanCurrent ( )

Makes the next boolean feature of the work part current.

If replay is going on, it will stop.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Features::FeatureReplayBuilder::MakeNextCurrent ( )

Makes the next feature of the work part current.

If replay is going on, it will stop.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Features::FeatureReplayBuilder::MakePreviousCurrent ( )

Makes the previous feature of the work part current.

If replay is going on, it will stop.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Features::FeatureReplayBuilder::Pause ( )

Pauses feature replay.

If replay is going on, it will pause.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Features::FeatureReplayBuilder::Play ( )

Starts feature replay.

If feature replay is in paused state, it will continue from the paused state. Replay will continue to the feature number as set by NXOpen::Features::FeatureReplayBuilder::ReplayTimestampNumber and NXOpen::Features::FeatureReplayBuilder::SetReplayTimestampNumber . If NXOpen::Features::FeatureReplayBuilder::ReplayTimestampNumber and NXOpen::Features::FeatureReplayBuilder::SetReplayTimestampNumber is more than the current feature, feature replay will continue to NXOpen::Features::FeatureReplayBuilder::ReplayTimestampNumber and NXOpen::Features::FeatureReplayBuilder::SetReplayTimestampNumber - one feature at a time and there will be a delay of NXOpen::Features::FeatureReplayBuilder::SecondsBetweenSteps and NXOpen::Features::FeatureReplayBuilder::SetSecondsBetweenSteps seconds between replay of each feature. If NXOpen::Features::FeatureReplayBuilder::ReplayTimestampNumber and NXOpen::Features::FeatureReplayBuilder::SetReplayTimestampNumber is less than the current feature, feature NXOpen::Features::FeatureReplayBuilder::ReplayTimestampNumber and NXOpen::Features::FeatureReplayBuilder::SetReplayTimestampNumber will be made current feature and no steps are shown.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

int NXOpen::Features::FeatureReplayBuilder::ReplayTimestampNumber ( )

Returns the replay timestamp number of feature.

If this feature is more than the current feature, feature replay will continue to this feature showing the steps in between. If this feature is less than the current feature, this feature will be made current on next replay.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

double NXOpen::Features::FeatureReplayBuilder::SecondsBetweenSteps ( )

Returns the delay in seconds between replay steps
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::Features::FeatureReplayBuilder::SetReplayTimestampNumber ( int  replayTimestampNumber)

Sets the replay timestamp number of feature.

If this feature is more than the current feature, feature replay will continue to this feature showing the steps in between. If this feature is less than the current feature, this feature will be made current on next replay.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
replayTimestampNumberreplaytimestampnumber
void NXOpen::Features::FeatureReplayBuilder::SetSecondsBetweenSteps ( double  secondsBetweenSteps)

Sets the delay in seconds between replay steps
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
secondsBetweenStepssecondsbetweensteps

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