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

---

Read-Only Properties

The following properties can be accessed:

• BaseList2D::GetBubbleHelp() : Returns the bubble help text.
• BaseList2D::GetIcon() : Fills the given icon data.
• BaseList2D::GetTypeName() : Returns the name of the element's type.
• BaseList2D::GetMain() : Returns the parent of the owning GeListHead 。见 Heads and Branches .

特性

数据

BaseList2D based objects store an internal BaseContainer . This BaseContainer can store various information, like for example (but not restricted to) the values of parameters of an object or tag.

• BaseList2D::GetData() : Returns a copy of the internal BaseContainer .
• BaseList2D::SetData() : The internal data is merged or replaced with the given BaseContainer .
• BaseList2D::GetDataInstance() : Returns a pointer to the internal BaseContainer .
• BaseList2D::GetDataInstanceRef() : Returns a reference to the internal BaseContainer .

见 BaseContainer Manual .

// get the "real" object BaseObject * const obj = static_cast< BaseObject * > (node);

// get data container BaseContainer & data = obj-> GetDataInstanceRef ();

// set default parameter values data. SetBool (EXAMPLE_GENERATOR_PARAMETER_BOOL, true ); data. SetInt32 (EXAMPLE_GENERATOR_PARAMETER_VALUE, 123);

注意

Typically one should use C4DAtom::SetParameter() and C4DAtom::GetParameter() to access parameters, instead of accessing the BaseContainer directly. See C4DAtom 参数 .

Bits

Various properties are not stored in parameters but are set using bits. See BIT .

• BaseList2D::SetBit() : Sets the given bit.
• BaseList2D::GetBit() : Returns true if the given bit is set.
• BaseList2D::DelBit() : Deletes the given bit.
• BaseList2D::ToggleBit() : Toggles the given bit.
• BaseList2D::GetAllBits() : Returns all bits of the element.
• BaseList2D::SetAllBits() : Sets all bits of the element.

另请参阅 GeListNode NBits .

名称

A BaseList2D based element can have a name. Often this name is used in Cinema 4D 's UI, like names of objects in the Object Manager:

• BaseList2D::GetName() : Returns the element's name.
• BaseList2D::SetName() : Sets the element's name.

注意

While BaseDocument is as well derived from BaseList2D , the "name" of a document is a Filename set with BaseDocument::SetDocumentName() 。见 BaseDocument Document Name and Path .

着色器

By default a BaseList2D based element can host a list of shaders. If a new shader is created and used by the element, it must be inserted into the element's shader list.

• BaseList2D::GetFirstShader() : Returns the first shader of the shader list.
• BaseList2D::InsertShader() : Inserts the given shader into the shader list.

另请参阅 GeListNode Lists and Trees .

Marker

A BaseList2D based element owns a GeMarker 对象。

• BaseList2D::GetMarker() : Returns the element's marker.
• BaseList2D::SetMarker() : Sets the element's marker.

见 GeMarker Manual 了解更多信息。

// search object with the same name const BaseObject * const foundObject = doc-> SearchObject (objectName); if (foundObject != nullptr ) { // check if it is the same object const GeMarker & foundObjectMarker = foundObject-> GetMarker ();

// compare if the markers are equal if (foundObjectMarker. 比较 (marker) == 0) ApplicationOutput ( "The found object is the original object" _s); else ApplicationOutput ( "The found object is not the original object" _s); }

Unique ID

BaseList2D based elements can store an array of unique IDs. These IDs are typically used to identify scenes and elements written by external applications using the Melange library.

• BaseList2D::AddUniqueID() : Adds a new unique ID.
• BaseList2D::FindUniqueID() : Returns true if a unique ID for the given application ID was found.
• BaseList2D::GetUniqueIDCount() : Returns the number of stored IDs.
• BaseList2D::GetUniqueIDIndex() : Gets the data of the given application ID.
• MAXON_CREATOR_ID : The application ID that accesses the internally stored GeMarker .

// adding a new ID const Int32 ID = 1111111; Int32 value = 123456; object ->AddUniqueID(ID, ( Char *)&value, sizeof ( Int32 )); Int32 appID = 0; const Char * memory = nullptr ; Int bytes = 0;

// looping through all IDs for ( Int32 i = 0; i < object ->GetUniqueIDCount(); ++i) { // get the unique ID data stored at the given index if (object-> GetUniqueIDIndex (i, appID, memory, bytes)) { ApplicationOutput ( "ID: " + String::IntToString (appID));

// check if the memory block has the size of an Int32 number if (bytes == sizeof ( Int32 )) { const Int32 data = *( Int32 *)memory; ApplicationOutput ( "Value: " + String::IntToString (data)); } } }

Animation Tracks

BaseList2D based elements store a list of CTrack objects (see also Heads and Branches ). A CTrack stores the animation data for a given parameter.

• BaseList2D::GetCTrackRoot() ：返回 GeListHead that stores the element's tracks.
• BaseList2D::GetFirstCTrack() : Returns the first CTrack in the list.
• BaseList2D::FindCTrack() ：返回 CTrack for the given parameter ID.
• BaseList2D::InsertTrackSorted() : Adds the given CTrack to the object. The object takes ownership.

// check if track exists CTrack * track = sphere-> FindCTrack (paramID); if (track != nullptr ) return maxon::OK ;

// create track track = CTrack::Alloc (sphere, paramID); if (track == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// insert track sphere-> InsertTrackSorted (track);

见 动画概述 .

Keyframe Selection

Parameters can be part of a so called keyframe selection:

• BaseList2D::ClearKeyframeSelection() : Clears the keyframe selection.
• BaseList2D::FindKeyframeSelection() : Returns true if the given parameter ID is part of the keyframe selection.
• BaseList2D::SetKeyframeSelection() : Sets the keyframe selection status of the given parameter ID.
• BaseList2D::KeyframeSelectionContent() : Returns true if there are any parameters in the current keyframe selection.

// check if any parameters on the object are part of the keyframe selection if (object-> KeyframeSelectionContent ()) { // read description from the object if (!object-> GetDescription (description, DESCFLAGS_DESC::NONE )) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); void * handle = description-> BrowseInit (); const BaseContainer * bc = nullptr ; DescID id, gid;

// loop through the description while (description-> GetNext (handle, &bc, id , gid)) { // check if the parameter ID is part of the keyframe selection if (object-> FindKeyframeSelection ( id ) && bc) { ApplicationOutput ( "Parameter \"" + bc-> GetString ( DESC_NAME ) + "\" is part of the keyframe selection" ); } } }

另请参阅 C4DAtom Parameter Properties and 动画 .

层

A BaseList2D based element can be part of a layer:

• BaseList2D::GetLayerObject() ：返回 LayerObject representing the element's layer or nullptr .
• BaseList2D::SetLayerObject() : Sets the layer of the element.
• BaseList2D::GetLayerData() : Returns the layer data of the object's layer.
• BaseList2D::SetLayerData() : Sets the layer data of the object's layer.

// get layer object LayerObject * const layer = object -> GetLayerObject (doc); if (layer != nullptr ) { // get layer data const LayerData * const ld = object ->GetLayerData(doc); if (ld != nullptr ) { // check if elements should be visible in the Editor if (ld-> view ) ApplicationOutput ( "visible" _s); else ApplicationOutput ( "invisible" _s); } }

另请参阅 Layer Manual .

DescID State

For each parameter ID a certain state can be defined. This is typically managed by the Xref or Take system.

• BaseList2D::SetDescIDState() : Sets the state of the given parameter ID.
• BaseList2D::GetDescIDState() : Returns the state of the given parameter ID.

The flags are:

• DESCIDSTATE::NONE : None.
• DESCIDSTATE::LOCKED : 描述 element is locked.
• DESCIDSTATE::HIDDEN : 描述 element is hidden.
• DESCIDSTATE::OVERRIDE : 描述 is overridden.
• DESCIDSTATE::FORBIDOVERRIDE : 描述 cannot be overridden.

Functionality

BaseList2D based elements can be edited with these functions:

• BaseList2D::TransferGoal() : Changes all BaseLink objects pointing to this element to point to the given BaseList2D .
• BaseList2D::Scale() : Scales all parameters with length units with the given factor.
• BaseList2D::Edit() : Triggers the edit action for the object by sending the MSG_EDIT message (see 交互 ).

// scale the clone's float parameters clone-> 比例 (2.0);

// all links should now refer to the clone object ->TransferGoal(clone, false );

// edit the clone clone-> 编辑 ();

延伸阅读

• C4DAtom Manual
• GeListNode Manual
• DescID Manual
• GeMarker Manual
• Layer Manual