KFbxProcessorXRefCopy Class Reference
Detailed Description
This class contains objects This class also provides access to global settings and take information.
Definition at line 52 of file kfbxprocessorxref.h.
#include <kfbxprocessorxref.h>
Classes |
|
| struct | KFbxAutoRevertPropertyChanges |
| This is just a safety net to make sure
RevertPropertyChanges is called when this goes out of scope.
More... |
|
| class | KFbxMissingUrlHandler |
| struct | KFbxPropertyUpdate |
| Since KFbxProperty is an opaque
type, we can't do an efficient operator < on it, and must keep
the data on the object, which can be compared through pointers, and
then we can further compare against the property name.
More... |
|
Public Types |
|
| typedef KSet2< KFbxPropertyUpdate > | KFbxUpdateSet |
| typedef
KMap< KFbxObject *, KFbxUpdateSet > |
KFbxPropertyUpdateMap |
Public Member Functions |
|
| KFbxPropertyUpdateMap & | GetUpdatedProperties () |
| All properties that were updated, with their
original value. |
|
| void | RevertPropertyChanges () |
| If property tracking was enabled, goes
through and reverts all changes to the properties. |
|
Public Attributes |
|
| KFbxMissingUrlHandler * | MissingUrlHandler |
| Optional callback; when set, this will be
called when an Url cannot be be copied because the source is not
found. |
|
|
Properties
|
|
| KFbxTypedProperty< fbxString > | OutputDirectory |
| KFbxTypedProperty< fbxBool1 > | UpdateProperties |
| As we resolve xref and copy assets, do we
update properties to now use this relative path? Defaults to TRUE.
|
|
| KFbxTypedProperty< fbxBool1 > | TrackUpdatedProperties |
| Default to FALSE -- when set, this informs
the processor to track every properties that were modified during
the scene processing. |
|
| KFbxTypedProperty< fbxBool1 > | ForceCopy |
| Default to TRUE -- when not set, files are
only copied if one of the following conditions is met: |
|
| KFbxTypedProperty< fbxBool1 > | CopyFileTimes |
| Default to TRUE -- when copying a file, also
copy its modification time. |
|
Protected Member Functions |
|
| KFbxProcessorXRefCopy (KFbxSdkManager &pManager, char const *pName) | |
| bool | ConstructProperties (bool pForceSet) |
| bool | ShouldCopyFile (const KString &pTarget, const KString &pSource) const |
|
Overridable internal function
|
|
| virtual bool | internal_ProcessCollectionBegin (KFbxCollection *pObject) |
| virtual bool | internal_ProcessCollectionEnd (KFbxCollection *pObject) |
| virtual bool | internal_ProcessObject (KFbxObject *pObject) |
| bool | ProcessPathProperty (KFbxProperty &pProperty) |
| virtual bool | ValidPropertyForXRefCopy (KFbxObject *pObject, KFbxProperty &lProperty) const |
Protected Attributes |
|
| KFbxPropertyUpdateMap | mUpdatedProperties |
Member Typedef Documentation
| typedef KSet2<KFbxPropertyUpdate> KFbxUpdateSet |
Definition at line 119 of file kfbxprocessorxref.h.
| typedef KMap<KFbxObject*, KFbxUpdateSet> KFbxPropertyUpdateMap |
Definition at line 120 of file kfbxprocessorxref.h.
Constructor & Destructor Documentation
| KFbxProcessorXRefCopy | ( | KFbxSdkManager & | pManager, |
| char const * | pName | ||
| ) | [protected] |
Member Function Documentation
| KFbxPropertyUpdateMap& GetUpdatedProperties | ( | ) |
All properties that were updated, with their original value.
Will always be empty if TrackUpdatedProperties was not set before calling ProcessCollection/ProcessObject. NOT cleared before each processing run.
| void RevertPropertyChanges | ( | ) |
If property tracking was enabled, goes through and reverts all changes to the properties.
Does not un-copy the files, naturally.
| bool ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Reimplemented from KFbxObject.
Reimplemented in KFbxProcessorXRefCopyUserLibrary.
| virtual bool internal_ProcessCollectionBegin | ( | KFbxCollection * | pObject | ) | [protected, virtual] |
Reimplemented from KFbxProcessor.
| virtual bool internal_ProcessCollectionEnd | ( | KFbxCollection * | pObject | ) | [protected, virtual] |
Reimplemented from KFbxProcessor.
| virtual bool internal_ProcessObject | ( | KFbxObject * | pObject | ) | [protected, virtual] |
Reimplemented from KFbxProcessor.
| bool ProcessPathProperty | ( | KFbxProperty & | pProperty | ) | [protected] |
| virtual bool ValidPropertyForXRefCopy | ( | KFbxObject * | pObject, |
| KFbxProperty & | lProperty | ||
| ) | const [protected, virtual] |
Reimplemented in KFbxProcessorXRefCopyUserLibrary.
Member Data Documentation
Definition at line 68 of file kfbxprocessorxref.h.
As we resolve xref and copy assets, do we update properties to now use this relative path? Defaults to TRUE.
Definition at line 73 of file kfbxprocessorxref.h.
Default to FALSE -- when set, this informs the processor to track every properties that were modified during the scene processing.
Definition at line 78 of file kfbxprocessorxref.h.
Default to TRUE -- when not set, files are only copied if one of the following conditions is met:
1) Target does not exist 2) Target has a different time 3) Target has a different size
Definition at line 87 of file kfbxprocessorxref.h.
Default to TRUE -- when copying a file, also copy its modification time.
A bit of a requirement if you're not going to use ForceCopy.
Definition at line 92 of file kfbxprocessorxref.h.
Optional callback; when set, this will be called when an Url cannot be be copied because the source is not found.
Memory is owned by the client code, and will not be freed by us.
Definition at line 99 of file kfbxprocessorxref.h.
KFbxPropertyUpdateMap
mUpdatedProperties [protected] |
Definition at line 157 of file kfbxprocessorxref.h.
The documentation for this class was generated from the following file:
- fbxfilesdk/fbxprocessors/kfbxprocessorxref.h
