就业培训     下载中心     Wiki     联络 登录   注册

---

// read the "Path to Alembic file" parameter if (!object-> GetParameter ( DescID ( ALEMBIC_PATH ), data, DESCFLAGS_GET::NONE )) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); ApplicationOutput ( "Alembic File: " + data. GetFilename (). GetString ());

Combine

A Filename can be constructed with basic operators:

• Filename::operator+() : Concatenates the two filenames.
• Filename::operator+=() : Concatenates the filenames and set the left-hand operand to the result.

注意

Only the last part (typically the file) of the given Filename is added.

// open a folder selector dialog if (!selectFolder. FileSelect ( FILESELECTTYPE::ANYTHING , FILESELECT::DIRECTORY , "Select Folder" _s)) return maxon::OK ; const Filename fullFilePath = selectFolder + "cube.c4d" ;

// check if given file exists if ( GeFExist (fullFilePath)) ApplicationOutput ( "The folder contains \"cube.c4d\"" ); else ApplicationOutput ( "The folder does not container \"cube.c4d\"" );

// This example constructs the Filename for an image file // in the plugin's "res" folder and loads this image.

// construct full file name const Filename imageFile = GeGetPluginPath () + Filename ( "res" ) + Filename ( "arbitrary_icon.tif" );

// check if the file exists if (! GeFExist (imageFile)) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); AutoAlloc<BaseBitmap> bitmap; if (bitmap == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// load image file into the given BaseBitmap if (bitmap-> Init (imageFile) != IMAGERESULT::OK ) return maxon::UnknownError( MAXON_SOURCE_LOCATION );

// show BaseBitmap in the Picture Viewer ShowBitmap (bitmap);

拷贝

A Filename object can easily be copied:

• Filename::operator=() : Assigns the right-operand filename to the left-operand filename.
• Filename::CopyTo() : Copies the filename into the given Filename 对象。

特性

String

The content of a Filename object can be represented by a String :

• Filename::IsPopulated() : Returns true if the filename has been set.
• Filename::GetString() : Returns the full filename as a String .
• Filename::SetString() : Sets the filename with the given String .

另请参阅 String Manual (Classic) .

File and Directory

A filename may be composed of a directory part and a file part. Each part can be edited independently:

• Filename::GetDirectory() : Returns the directory of the filename.
• Filename::SetDirectory() : Sets the directory of the filename.
• Filename::GetFile() : Returns the file part of the filename.
• Filename::SetFile() : Sets the file part of the filename.
• Filename::GetFileString() : Returns the file part of the filename as a String .

Suffix

Part of the filename may also be the file suffix. This suffix can be edited separately:

• Filename::GetSuffix() : Returns the suffix as a String .
• Filename::SetSuffix() : Sets the suffix to the given string.
• Filename::ClearSuffix() : Clears the suffix.
• Filename::ClearSuffixComplete() : Clears also suffixes longer than seven characters.
• Filename::CheckSuffix() : Checks if the suffix is equal to the given string.

// check if the given Filename references a Cinema 4D scene file if (selectedFile.CheckSuffix( "c4d" _s)) ApplicationOutput ( "C4D File" ); else ApplicationOutput ( "Some other file" );

It is possible to get the suffix for a given image file type:

• GeFilterSetSuffix() : Sets the standard suffix of a given bitmap saver plugin.

Memory Mode

The memory mode allows to perform read and write operations on a memory block instead of a file on the hard drive. This is typically used to encrypt or compress the resulting data.

• Filename::SetMemoryReadMode() : Sets the filename to read from a memory block.
• Filename::SetMemoryWriteMode() : Sets the filename to write to a memory block.

// open HyperFile to write if (!hyperFile->Open(0, fn, FILEOPEN::WRITE , FILEDIALOG::NONE )) return maxon::UnknownError( MAXON_SOURCE_LOCATION ); hyperFile->WriteInt32(123); hyperFile->WriteString( "foo" _s); hyperFile->WriteString( "bar" _s); hyperFile->WriteInt32(456); hyperFile->Close();

// get raw data mfs-> GetData (data, size, false );

注意

The data stored in memory may be written to a file using HyperFile::WriteMemory() .

Functionality

Select Files and Folders

A Filename object is also useful to open dialogs to select files and folders:

• Filename::FileSelect() : Opens a dialog to select a file or a folder.

The files that can be selected in a dialog can be filtered with these flags:

• FILESELECTTYPE::ANYTHING : Allow any file.
• FILESELECTTYPE::IMAGES : Allow only image files.
• FILESELECTTYPE::SCENES : Allow only 3D scene files.
• FILESELECTTYPE::BODYPAINT : Allow only BodyPaint 3D files.

The type of dialog is defined with this flag:

• FILESELECT::LOAD : Opens a "Load" dialog.
• FILESELECT::SAVE : Opens a "Save" dialog.
• FILESELECT::DIRECTORY : Opens a folder selections dialog.

// open a file selector dialog to open a file if (loadFile. FileSelect ( FILESELECTTYPE::ANYTHING , FILESELECT::LOAD , "Load File" _s)) ApplicationOutput ( "File to load: " + loadFile. GetString ()); Filename saveFile;

// open a file selector dialog to save a file if (saveFile. FileSelect ( FILESELECTTYPE::ANYTHING , FILESELECT::SAVE , "Save File" _s)) ApplicationOutput ( "File to save: " + saveFile. GetString ()); Filename folder;

// open a folder selector dialog if (folder. FileSelect ( FILESELECTTYPE::ANYTHING , FILESELECT::DIRECTORY , "Select Folder" _s)) ApplicationOutput ( "Folder: " + folder. GetString ());

Preset Browser

A Filename object may also be used to reference a file located in Cinema 4D 's content browser.

• Filename::IsBrowserUrl() : Returns true if the Filename contains a content browser url.

// access a filename parameter if (node-> GetParameter ( DescID (ID_FILENAME), geData, DESCFLAGS_GET::NONE )) { const Filename filename = geData. GetFilename ();

// check if the given Filename // is a preset URL if (filename. IsBrowserUrl ()) ApplicationOutput ( "File is stored in presets" _s); }

比较

Two Filename objects can be compared easily:

• Filename::operator==() : Returns true if the filenames are the same.
• Filename::operator!=() : Returns true if the filenames are not the same.

// open folder selector dialog if (folder. FileSelect ( FILESELECTTYPE::ANYTHING , FILESELECT::DIRECTORY , "Select Folder" _s)) { if (folder == desktop) ApplicationOutput ( "You selected the desktop." ); else ApplicationOutput ( "You selected " + folder. GetString ()); }

Disc I/O

A Filename object can be stored in a BaseFile 或 HyperFile using:

• BaseFile::ReadFilename() : Reads the Filename 从 BaseFile .
• BaseFile::WriteFilename() : Writes the Filename 到 BaseFile .

// open BaseFile to write if (!bf-> Open (filename, FILEOPEN::WRITE , FILEDIALOG::ANY )) return maxon::UnknownError( MAXON_SOURCE_LOCATION ); bf-> WriteFilename (filenameData); bf-> 关闭 ();

// This example reads a String form the given BaseFile. AutoAlloc<BaseFile> bf; if (bf == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// open BaseFile to read if (!bf-> Open (filename, FILEOPEN::READ , FILEDIALOG::ANY )) return maxon::UnknownError( MAXON_SOURCE_LOCATION ); Filename filenameData; bf-> ReadFilename (&filenameData); ApplicationOutput ( "Filename from BaseFile: " + filenameData. GetString ()); bf-> 关闭 ();

• HyperFile::ReadFilename() : Reads the Filename 从 HyperFile .
• HyperFile::WriteFilename() : Writes the Filename 到 HyperFile .

// open HyperFile to write if (!hf-> Open (753, filename, FILEOPEN::WRITE , FILEDIALOG::ANY )) return maxon::UnknownError( MAXON_SOURCE_LOCATION ); hf-> WriteFilename (filenameData); hf-> 关闭 ();

// This example reads a String from the given HyperFile. AutoAlloc<HyperFile> hf; if (hf == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// open HyperFile to read if (!hf-> Open (753, filename, FILEOPEN::READ , FILEDIALOG::ANY )) return maxon::UnknownError( MAXON_SOURCE_LOCATION ); Filename filenameData; hf-> ReadFilename (&filenameData); ApplicationOutput ( "Filename from HyperFile: " + filenameData. GetString ());

延伸阅读

• GeData Manual
• BaseContainer Manual
• String Manual (Classic)
• Filename Manual