Allocation/Deallocation

BaseObject objects are created with the usual tools:

• BaseObject::Alloc() : Creates a new BaseObject .
• BaseObject::Free() : Deletes the given BaseObject .

The object IDs of many build-in object types are defined in Object Types .

Primitive objects can also be created with these dedicated functions:

• GeneratePrimitive() : Creates standard Cinema 4D primitives.
• GenerateSplinePrimitive() : Creates standard Cinema 4D spline primitives.
• GenerateText() : Creates splines from a string.

New objects are typically added to a BaseDocument that takes ownership:

• BaseDocument::InsertObject() : Inserts a BaseObject into the scene.
• GeListNode::InsertUnder() : Inserts the element under the given element.
• InsertCreateObject() : This function takes care for modifiers to add the given object in the given BaseDocument at a certain place in the hierarchy.

移除

A BaseObject can be removed from the host BaseDocument :

• GeListNode::Remove() : Removes the element from the host.

Navigate

BaseObject elements are organized in a tree. The usual functions can be used to navigate in that tree:

• BaseObject::GetNext() : Returns the next BaseObject in the list.
• BaseObject::GetPred() : Returns the previous BaseObject in the list.
• BaseObject::GetUp() : Returns the parent BaseObject .
• BaseObject::GetDown() : Returns the first child BaseObject .
• BaseObject::GetDownLast() : Returns the last child BaseObject .
• BaseObject::SearchHierarchy() : Checks if the objects is child of the given BaseObject .

另请参阅 Navigation in Lists and Trees .

Read-Only Properties

Bounding Box

The bounding box defines the dimensions of a BaseObject .

• BaseObject::GetMp() : Returns the object's bounding box center in local space.
• BaseObject::GetRad() : Returns the object's bounding box radius (x/y/z).

缓存

Generator objects store virtual child objects in a cache. If a deformer is applied, the deformed child objects are found in the deform cache.

• BaseObject::GetCache() : Returns the object from the previously built cache. The returned object may have child objects.
• BaseObject::GetDeformCache() : Returns the previously built cache that has been deformed by an active deformer.
• BaseObject::GetCacheParent() : If the BaseObject is in a cache this function will return the parent generator.

另请参阅 Generating .

杂项

Further functions are:

• BaseObject::GetGUID() : Returns a unique ID for any object in a document. This unique ID is a checksum based on several object properties.
• BaseObject::GetHighlightHandle() : Only needed if one draws handles in a plugin.
• BaseObject::GetRealSpline() : Returns a real spline representation of a primitive spline object. See also Flags .

// check if the object is a "Spline" object if (object-> IsInstanceOf ( Ospline )) spline = ToSpline ( object ); // check if the object is a spline generator else if (object-> GetInfo () & OBJECT_ISSPLINE ) spline = object -> GetRealSpline (); if (spline != nullptr ) ApplicationOutput ( "Spline Object: " + spline-> GetName ());

特性

参数

The basic parameters IDs of a BaseObject are defined in obase.h . They can be changed using C4DAtom::SetParameter() and C4DAtom::GetParameter() . For several properties dedicated functions exist.

PSR

The placement of an object is defined by its position, scale and rotation (PSR). Freeze Transformations allow to define a default or reset value. In short, the absolute value is the frozen value plus the relative value.

注意

The "absolute" values are not the world space values.

These functions give access to the "absolute" values:

• BaseObject::GetAbsPos() : Returns the absolute position.
• BaseObject::SetAbsPos() : Sets the absolute position.
• BaseObject::GetAbsScale() : Returns the absolute scale.
• BaseObject::SetAbsScale() : Sets the absolute scale.
• BaseObject::GetAbsRot() : Returns the absolute rotation.
• BaseObject::SetAbsRot() : Sets the absolute rotation.

These functions give access to the "frozen" values:

• BaseObject::GetFrozenPos() : Returns the frozen position.
• BaseObject::SetFrozenPos() : Sets the frozen position.
• BaseObject::GetFrozenScale() : Returns the frozen scale.
• BaseObject::SetFrozenScale() : Sets the frozen scale.
• BaseObject::GetFrozenRot() : Returns the frozen rotation.
• BaseObject::SetFrozenRot() : Sets the frozen rotation.

These functions give access to the "relative" values:

• BaseObject::GetRelPos() : Returns the relative position.
• BaseObject::SetRelPos() : Sets the relative position.
• BaseObject::GetRelScale() : Returns the relative scale.
• BaseObject::SetRelScale() : Sets the relative scale.
• BaseObject::GetRelRot() : Returns the relative rotation.
• BaseObject::SetRelRot() : Sets the relative rotation.

These functions are used to access the local and global Matrix of an object:

• BaseObject::GetMg() : Returns the world (global) matrix.
• BaseObject::SetMg() : Sets the world (global) matrix.
• BaseObject::GetMgn() : Returns the world (global) normalized matrix.
• BaseObject::GetMl() : Returns the local matrix.
• BaseObject::SetMl() : Sets the local matrix.
• BaseObject::GetFrozenMln() : Returns the frozen and normalized matrix of the object.
• BaseObject::GetRelMln() : Returns the relative and normalized matrix of the object.
• BaseObject::GetRelMl() : Returns the relative matrix of the object.
• BaseObject::SetRelMl() : Sets the relative matrix of the object.
• BaseObject::GetMln() : Returns the local normalized matrix.
• BaseObject::GetUpMg() : Returns the world (global) matrix of the parent object.
• BaseObject::CopyMatrixTo() : Copies the object's matrix to the given BaseObject .

另请参阅 Vector Manual (Classic) and Matrix Manual (Classic) .

Visibility

A BaseObject may or may not be visible in the editor and rendered output.

• BaseObject::GetEditorMode() : Returns the editor mode of the object.
• BaseObject::SetEditorMode() : Sets the editor mode of the object.
• BaseObject::GetRenderMode() : Returns the render mode of the object.
• BaseObject::SetRenderMode() : Sets the render mode of the object.

The modes are:

• MODE_ON : The object is enabled regardless of the state of any parent object.
• MODE_OFF : The object is disabled regardless of the state of any parent object.
• MODE_UNDEF : The object is enabled by default, but the state of any parent object is used if it is enabled or disabled.

注意

CheckEditorVisibility() checks the editor mode effect and layer settings of the given object, see Utility .

Generator / Deformer enabled

If an object is a generator or deformer it can be enabled or disabled:

• BaseObject::GetDeformMode() : Returns the enabled mode.
• BaseObject::SetDeformMode() : Sets the enabled mode.

// check if the object is a // "Subdivision Surface" if (object-> IsInstanceOf ( Osds )) { object ->SetDeformMode( false ); }

Tags

A BaseObject can host a variable number of tags. These tags add additional functionality and data to the object.

另请参阅 BaseTag and VariableTag Manual .

警告

Since R17 the Take System can add and own tags. See Take System Overview .

Existing tags can be accessed with:

• BaseObject::GetFirstTag() : Returns the first tag of the object.
• BaseObject::GetTag() : Returns a tag of the given type if existing on the host object.
• BaseObject::GetLastTag() : Returns the last tag of the host object.
• BaseObject::GetTagDataR() : Returns a pointer to the read-only data of the VariableTag .
• BaseObject::GetTagDataW() : Returns a pointer to the writeable data of the VariableTag .
• BaseObject::GetTagDataCount() : Returns the number of elements stored in the VariableTag .

New tags can be created:

• BaseObject::MakeTag() : Creates a new BaseTag of the given type.
• BaseObject::MakeVariableTag() : Creates a new VariableTag of the given type.
• BaseObject::InsertTag() : Inserts the given BaseTag into the object's tag list.
• BaseObject::SetPhong() : Creates a Phong tag.

and

Further tag related functionality:

• BaseObject::KillTag() : Deletes a hosted tag of the given type.
• BaseObject::CopyTagsTo() : Copies the tags of this object onto the given BaseObject .
• BaseObject::GetVisibility() : Gets the visibility of the assigned Display tag.

// loop until no "Annotation" tag can be found anymore while (object-> GetTag ( Tannotation )) { object ->KillTag( Tannotation ); }

颜色

A BaseObject can have an assigned color and can be displayed in xray mode:

• BaseObject::GetColorProperties() : Gets the object's color properties.
• BaseObject::SetColorProperties() : Sets the object's color properties.

The settings are:

• ObjectColorProperties::usecolor : The color mode. See obase.h for values.
• ObjectColorProperties::color : The color.
• ObjectColorProperties::xray : True if xray mode is enabled.

注意

To set the color of virtual objects in ObjectData::GetVirtualObjects() a generator must be registered with OBJECT_USECACHECOLOR ，见 Flags and Generating .

Modeling Axis

In certain modeling modes a modeling axis is presented as the result of the current selection.

• BaseObject::GetModelingAxis() : Returns the modeling axis matrix.
• BaseObject::SetModelingAxis() : Sets the modeling axis matrix.

注意

The axis of a multiselection can be obtained from the document, see BaseDocument Axis and Plane .

Generating

A generator object creates virtual and cached BaseObject elements in its ObjectData::GetVirtualObjects() function. The following BaseObject member functions are only used in this context.

While creating the cache one should typically check if the cache is already build:

• BaseObject::CheckCache() : Returns true if the cache is build and matches the requirements.

另请参阅 缓存 .

Generators can use child objects as input objects (see flag OBJECT_INPUT ). A generator can check if these child objects are dirty and it can hide them in the viewport. The most simple way is to handle the child objects manually:

• BaseObject::IsDirty() : Returns true if the object has been changed since the last time the object was touched.
• BaseObject::SetDirty() : Sets the dirty flags if any part of the object was changed.
• BaseObject::Touch() : Marks objects to be used by a generator. Automatically resets dirty values for use with BaseObject::IsDirty() .
• BIT_CONTROLOBJECT : Input objects are marked by a generator with this bit using BaseObject::Touch() . This bit is also set for the generator object itself.

To handle multiple child objects a dependence list can be used:

• BaseObject::NewDependenceList() : Starts a new dependence list.
• BaseObject::AddDependence() : Adds a child object to the dependence list.
• BaseObject::CompareDependenceList() : Compares if anything in the dependence list has changed.
• BaseObject::TouchDependenceList() : Marks all the objects in the dependence list to be replaced by the generator.

But the most simple way is to use one of these two functions: They will return polygon versions of the child objects and hide them:

• BaseObject::GetHierarchyClone() : Generates a clone of the child objects of the parent generator.
• BaseObject::GetAndCheckHierarchyClone() : Similar to GetHierarchyClone() but if the hierarchy is not dirty no new clone is created.

注意

In some special cases (eg, Matrix Object) these functions don't work as expected (eg, wrong dirtiness). In these cases, a custom cache handling is needed.

// Fill the cache based on the polygon clone. // ...

If a generator creates multiple child objects each object must be uniquely identifiable. If the flag OBJECT_UNIQUEENUMERATION is set each object can receive an unique IP number.

• BaseObject::GetUniqueIP() : Returns the unique IP number.
• BaseObject::SetUniqueIP() : Sets the unique IP number.

注意

The unique IP must not be zero.

Isoparm lines can be used to display and accentuate certain lines in the viewport.

• BaseObject::GetIsoparm() : Returns the isoparm LineObject .
• BaseObject::SetIsoparm() : Sets the isoparm LineObject .

// check pointers if (segments && linePoints) { segments[0]. cnt = 2; linePoints[0] = 向量 (0, 0, 0); linePoints[1] = 向量 (0, 1000, 0); lineObject-> 消息 ( MSG_UPDATE ); polyObject-> SetIsoparm (lineObject); } }

Rotation Order

在 Cinema 4D the rotation of an object is stored as a 向量 . Each component of this vector corresponds to a rotation axis. The rotation result depends on the order in which the rotation is executed. For values see ROTATIONORDER .

• BaseObject::GetRotationOrder() : Returns the object's rotation order.
• BaseObject::SetRotationOrder() : Sets the object's rotation order.

注意

Typically used with MatrixToHPB() and HPBToMatrix() 。见 Matrix Manual (Classic) .

The rotation values of an animation can be optimized:

• BaseObject::FindBestEulerAngle() : Modifies the rotation values of the given rotation track to find the best Euler angle.

// animate the object so it uses the new key values doc-> AnimateObject (obj, doc-> GetTime (), ANIMATEFLAGS::NONE );

Quaternion Rotation Mode

The (animated) rotation values of an object can be interpolated using quaternions.

• BaseObject::IsQuaternionRotationMode() : Returns true if the rotation is interpolated in quaternion mode.
• BaseObject::SetQuaternionRotationMode() : Sets the object's interpolation mode.

// check if the object uses quaternion interpolation if (obj-> IsQuaternionRotationMode () == false ) { // turn on quaternion interpolation. // this will update the rotation animation tracks obj-> SetQuaternionRotationMode ( true , false ); }

The use of quaternion interpolation can be forced with:

• BaseObject::EvaluateSynchronizedRotation() : Evaluates all rotation tracks using quaternion interpolation.

Animation Tracks

These utility functions allow fast access to the animation tracks and curves of an animated 向量 parameter. See 动画概述 .

• BaseObject::GetVectorTracks() : Gets the animation tracks for each component of the given 向量 参数。
• BaseObject::GetVectorCurves() : Gets the animation curves for each component of the given 向量 参数。

注意

This is typically used with synchronized tracks, see CTrack Synchronisation .

// access track for each vector component if (obj-> GetVectorTracks (positionTrack, trackX, trackY, trackZ)) { if (trackX != nullptr ) ApplicationOutput ( "Track X: " + trackX-> GetName ()); if (trackY != nullptr ) ApplicationOutput ( "Track Y: " + trackY-> GetName ()); if (trackZ != nullptr ) ApplicationOutput ( "Track Z: " + trackZ-> GetName ()); }

This function is used to handle keys on a 向量 parameter:

• BaseObject::SynchronizeVectorTrackKeys() : Synchronizes the keys on the components of the given 向量 参数。

动画

An object can be animated using the host BaseDocument :

• BaseDocument::AnimateObject() : Animates the given object at the given frame.

注意

This function only animates the object based on its keyframes but does not care about expressions or other objects.

另请参阅 BaseDocument 动画 .

转换

Generators create and own virtual child objects. To access these child object one can read the cache of the generator (see 缓存 ). Another way is to apply the "Current State to Object" command to the given generator object.

• MCOMMAND_CURRENTSTATETOOBJECT : The "Current State to Object" ID for SendModelingCommand() .

// insert it into the temp doc. tempDoc-> InsertObject ( object , nullptr , nullptr );

// modify object object ->SetParameter( PRIM_TORUS_INNERRAD , 100.0, DESCFLAGS_SET::NONE ); ModelingCommandData mcd; mcd. doc = tempDoc; mcd. op = object;

// execute the "Current State to Object" modeling command if (! SendModelingCommand ( MCOMMAND_CURRENTSTATETOOBJECT , mcd)) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); C4DAtom * atom = mcd. result -> GetIndex (0); BaseObject * const res = static_cast< BaseObject * > (atom);

// check if the result object is a polygon object if (res && (res-> GetType () == Opolygon )) { doc-> InsertObject (res, nullptr , nullptr ); }

Bits

A BaseObject can be hidden in the Object Manager or viewport using these bits:

• NBIT::OHIDE : Hide object in Object Manager.
• NBIT::EHIDE : Hide object in viewport.

Flags

The flags of a BaseObject can be accessed with GeListNode::GetInfo() . These flags inform about the type of object and its behavior.

Object type:

• OBJECT_MODIFIER : The object is a deformer object.
• OBJECT_PARTICLEMODIFIER : The object is a particle modifier.
• OBJECT_GENERATOR : The object is a generator.
• OBJECT_ISSPLINE : The object is a spline generator
• OBJECT_POINTOBJECT : The object is a point object (for example the FFD object).
• OBJECT_POLYGONOBJECT : The object is a polygon object (for example the Joint object).
• OBJECT_FIELDOBJECT : The object is a Field object, see FieldObject Manual .

// check if the object is a "Spline" object if (object-> IsInstanceOf ( Ospline )) spline = ToSpline ( object ); // check if the object is a spline generator else if (object-> GetInfo () & OBJECT_ISSPLINE ) spline = object -> GetRealSpline (); if (spline != nullptr ) ApplicationOutput ( "Spline Object: " + spline-> GetName ());

Generator related flags:

• OBJECT_USECACHECOLOR : The generator object creates colors for cache objects. See 颜色 .
• OBJECT_UNIQUEENUMERATION : The generator object sets unique object IDs. See Generating .
• OBJECT_INPUT : The generator object uses input objects.

Other flags:

• OBJECT_CAMERADEPENDENT : Object is camera dependent.
• OBJECT_NO_PLA : PLA animation cannot be applied to this point object.
• OBJECT_CALL_ADDEXECUTION : ObjectData::Execute() will be called.

Utility

These utility functions can return the name of the object type or return the object type based on that name.

• GetObjectName() : Returns the user presentable name from an object type ID.
• GetObjectType() : Returns an object type from an object name.

These functions can be used to check if the given BaseObject is visible in the Editor:

• CheckEditorVisibility() : Checks the editor visibility by checking the BaseObject 's layer, bits and hierarchical editor settings.
• CheckDisplayFilter() : Checks if the given BaseObject is covered by the given display filter.

// check editor visibility const Bool editorVisibiliy = CheckEditorVisibility ( object );

// check if the object is visible in the viewport if (displayFilter && editorVisibiliy) { ApplicationOutput ( "The object is visible in the Editor" _s); } else { ApplicationOutput ( "The object is not visible in the Editor" _s); }

延伸阅读

• Scene Elements Overview
• BaseTag and VariableTag Manual
• BaseDocument Manual
• Vector Manual (Classic)
• Matrix Manual (Classic)