NX Open C++ Reference Guide
|
This class is the builder for the Movie Settings. More...
Public Types | |
enum | CaptureAreaChoices { CaptureAreaChoicesGraphics, CaptureAreaChoicesNxWindow, CaptureAreaChoicesDesktop } |
Indicates the are being recorded in the movie. More... | |
enum | PlaybackSpeedChoices { PlaybackSpeedChoicesVerySlow, PlaybackSpeedChoicesSlow, PlaybackSpeedChoicesAsRecorded, PlaybackSpeedChoicesFast, PlaybackSpeedChoicesVeryFast } |
Indicates the playback speed of the movie. More... | |
Public Member Functions | |
NXOpen::MovieSettingsBuilder::CaptureAreaChoices | CaptureArea () |
Returns the area captured for movie creation. More... | |
NXString | CodecFourcc () |
Returns the Codec that is used to create the movie. More... | |
int | FramesPerSecond () |
Returns the frames per second for the movie. More... | |
NXOpen::MovieSettingsBuilder::PlaybackSpeedChoices | PlaybackSpeed () |
Returns the speed at which the recorded movie is played back. More... | |
void | SetCaptureArea (NXOpen::MovieSettingsBuilder::CaptureAreaChoices captureArea) |
Sets the area captured for movie creation. More... | |
void | SetCodecFourcc (const NXString &codecFourcc) |
Sets the Codec that is used to create the movie. More... | |
void | SetCodecFourcc (const char *codecFourcc) |
Sets the Codec that is used to create the movie. More... | |
void | SetFramesPerSecond (int framesPerSecond) |
Sets the frames per second for the movie. More... | |
void | SetPlaybackSpeed (NXOpen::MovieSettingsBuilder::PlaybackSpeedChoices playbackSpeed) |
Sets the speed at which the recorded movie is played back. 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... | |
This class is the builder for the Movie Settings.
To create a new instance of this class, use NXOpen::MovieManager::CreateMovieSettingsBuilder
Default values.
Property | Value |
---|---|
CaptureArea |
Graphics |
FramesPerSecond |
10 |
PlaybackSpeed |
AsRecorded |
Created in NX6.0.0.
Indicates the are being recorded in the movie.
Indicates the playback speed of the movie.
NXOpen::MovieSettingsBuilder::CaptureAreaChoices NXOpen::MovieSettingsBuilder::CaptureArea | ( | ) |
Returns the area captured for movie creation.
Created in NX6.0.0.
License requirements : None
NXString NXOpen::MovieSettingsBuilder::CodecFourcc | ( | ) |
Returns the Codec that is used to create the movie.
Created in NX6.0.0.
License requirements : None
int NXOpen::MovieSettingsBuilder::FramesPerSecond | ( | ) |
Returns the frames per second for the movie.
This setting dictates the quality of the movie that is created. A smaller value would create a coarse movie with small file size, whereas, a bigger value would create a smooth movie with a big file size
Created in NX6.0.0.
License requirements : None
NXOpen::MovieSettingsBuilder::PlaybackSpeedChoices NXOpen::MovieSettingsBuilder::PlaybackSpeed | ( | ) |
Returns the speed at which the recorded movie is played back.
Created in NX6.0.0.
License requirements : None
void NXOpen::MovieSettingsBuilder::SetCaptureArea | ( | NXOpen::MovieSettingsBuilder::CaptureAreaChoices | captureArea | ) |
Sets the area captured for movie creation.
Created in NX6.0.0.
License requirements : None
captureArea | capturearea |
void NXOpen::MovieSettingsBuilder::SetCodecFourcc | ( | const NXString & | codecFourcc | ) |
Sets the Codec that is used to create the movie.
Created in NX6.0.0.
License requirements : None
codecFourcc | codecfourcc |
void NXOpen::MovieSettingsBuilder::SetCodecFourcc | ( | const char * | codecFourcc | ) |
Sets the Codec that is used to create the movie.
Created in NX6.0.0.
License requirements : None
codecFourcc | codecfourcc |
void NXOpen::MovieSettingsBuilder::SetFramesPerSecond | ( | int | framesPerSecond | ) |
Sets the frames per second for the movie.
This setting dictates the quality of the movie that is created. A smaller value would create a coarse movie with small file size, whereas, a bigger value would create a smooth movie with a big file size
Created in NX6.0.0.
License requirements : None
framesPerSecond | framespersecond |
void NXOpen::MovieSettingsBuilder::SetPlaybackSpeed | ( | NXOpen::MovieSettingsBuilder::PlaybackSpeedChoices | playbackSpeed | ) |
Sets the speed at which the recorded movie is played back.
Created in NX6.0.0.
License requirements : None
playbackSpeed | playbackspeed |