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

---

1. 首页
2. C4D R23.110 C++ SDK

公共成员函数 | 私有成员函数 | 所有成员列表

HierarchyObjectInterface Class Reference

#include <hierarchyobject.h>

Inheritance diagram for HierarchyObjectInterface:

[ legend ]

详细描述

Object that allows to create hierarchical tree like structures.

An object can have siblings and branches with children. By default the children are all stored in the default branch branchId == ConstDataPtr(). But you can add as many branches to categorize and separate different flavors of children. You can do this by defining different branches like in this example:

enum class IMAGEHIERARCHY { TEXTURE , IMAGE , ALPHA , LAYER , MASK , MAX_ELEMENTS , } MAXON_ENUM_LIST ( IMAGEHIERARCHY );

You can then pass the branch to one of the functions below by replacing the default ConstDataPtr() by a different id. This example will return the first child of IMAGEHIERARCHY::IMAGE branch.

成员函数文档编制

◆  MAXON_INTERFACE()

◆  MAXON_GENERIC()

◆  InsertBefore()

Inserts this object (including its children and next siblings, if any) into the hierarchy as the previous sibling of nextSibling. Before invocation, nextSibling needs to have either a previous sibling or a parent object, which will get the ownership of this object. This object will take over the ownership of nextSibling.

This object mustn't have a parent or a previous sibling.

参数

[in]

nextSibling

An object which shall become the next sibling of this object.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertAfter()

Inserts this object (including its children and next siblings, if any) into the hierarchy as the next sibling of prevSibling. prevSibling gets the ownership of this object.

This object mustn't have a parent or a previous sibling.

参数

[in]

prevSibling

Another object of which this object shall become the next sibling.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertAsFirstChildOf()

Insert this object (including its children and next siblings, if any) as the first child of the given parent object. The parent object gets the ownership of this object.

This object mustn't have a parent or a previous sibling.

参数

[in]	parent	Parent object under which the object should be inserted.
[in]	branchId	Defines the branch the child belongs to.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertAsLastChildOf()

Insert this object (including its children and next siblings, if any) as the last child of the given parent object. If there are already children existing in the given branch the last one will get ownership of this object. Otherwise the parent object gets the ownership of this object.

This object mustn't have a parent or a previous sibling.

参数

[in]	parent	Parent object under which the object should be inserted.
[in]	branchId	Defines the branch the child belongs to.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertAsChildAt()

Insert this object (including its children and next siblings, if any) as a child of the given parent position. For example if you specify a position of 3 and there are already 5 children existing the object will be inserted between the previously second and third child. If you specify a position of 1 the object will be inserted as the first child.

If a next sibling exists, this object gets ownership of the next sibling. If a previous sibling exists, the previous sibling gets the ownership of this object. Otherwise the parent object gets the ownership of this object.

This object mustn't have a parent or a previous sibling.

参数

[in]	parent	Parent object under which the object should be inserted.
[in]	position	A child of parent which shall become the next sibling of this object, or nullptr if this object shall become the last child.
[in]	branchId	Defines the branch the child belongs to.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertChildAsFirst()

Insert a child object (including its children and next siblings, if any) as the first child of this object. This object gets the ownership of the given child.

The child object mustn't have a parent or a previous sibling.

参数

[in]	child	Parent object under which the object should be inserted.
[in]	branchId	Defines the branch the children belongs to.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertChildAsLast()

Insert a child object (including its children and next siblings, if any) as the last child of this object. If there are already children existing in the given branch the last one will get ownership of the given child object. Otherwise this object gets the ownership of the given child.

The child object mustn't have a parent or a previous sibling.

参数

[in]	child	Parent object under which the object should be inserted.
[in]	branchId	Defines the branch the child belongs to.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertChildAt()

Insert a child object (including its children and next siblings, if any) as the given child position of this object. For example if you specify a position of 3 and there are already 5 children existing the child object will be inserted between the previously second and third child. If you specify a position of 1 the given child object will be inserted as the first child.

If a next sibling exists, the given child object gets ownership of the next sibling. If a previous sibling exists, the previous sibling gets the ownership of the given child object. Otherwise this object gets the ownership of the given child object.

The child object mustn't have a parent or a previous sibling.

参数

[in]	child	Parent object under which the object should be inserted.
[in]	position	A child of parent which shall become the next sibling of this object, or nullptr if this object shall become the last child.
[in]	branchId	Defines the branch the child belongs to.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertChildrenAsFirst()

Insert a list of child objects (including its children and next siblings, if any) as the first child of this object. This object gets the ownership of the given children.

Each child object mustn't have a parent or a previous sibling.

参数

[in]	children	Parent object under which the object should be inserted.
[in]	branchId	Defines the branch the children belong to.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertChildrenAsLast()

Insert a list of child objects (including its children and next siblings, if any) as the last child of this object. If there are already children existing in the given branch the last one will get ownership of the given children objects. Otherwise this object gets the ownership of the given children.

Each child object mustn't have a parent or a previous sibling.

参数

[in]	children	Parent object under which the object should be inserted.
[in]	branchId	Defines the branch the children belong to.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  InsertChildrenAt()

Insert a list of children objects (including its children and next siblings, if any) as the given child position of this object. For example if you specify a position of 3 and there are already 5 children existing the children will be inserted between the previously second and third child. If you specify a position of 1 the given children will bbe inserted as the first child.

If a next sibling exists, the last children object gets ownership of the next sibling. If a previous sibling exists, the previous sibling gets the ownership of the given children objects. Otherwise this object gets the ownership of the given children.

Each child object mustn't have a parent or a previous sibling.

参数

[in]	children	Parent object under which the object should be inserted.
[in]	position	A child of parent which shall become the next sibling of this object, or nullptr if this object shall become the last child.
[in]	branchId	Defines the branch the children belong to.

返回

OK on success. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  Replace()

Replace this object with the new one and remove it from the hierarchy. The new object will have the same prev/next siblings and descendants like this object.

返回

This object including the descendants hierarchy. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  Remove()

Removes this object from the hierarchy, including all descendants.

返回

This object including the descendants hierarchy.

◆  RemoveChildren()

Removes all descendants from the given branch hierarchy. The descendants hierarchy is returned as a reference which has the ownership of the descendants.

参数

[in]

branchId

Defines from which branch the children are removed.

返回

Descendants hierarchy. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  RemoveAllChildren()

Removes all descendants from the hierarchy including all branches.

◆  GetOwner()

Returns the owner of this object (and the whole hierarchy).

返回

Owner of hierarchy.

◆  GetFirstChild()

Returns the first child of this object.

参数

[in]

branchId

The branch.

返回

Child object or nullptr if not available. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  GetLastChild()

Returns the last child of this object.

参数

[in]

branchId

The branch.

返回

Child object or nullptr if not available. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  GetChildAt()

Returns the n'th child of this object.

参数

[in]	position	The child position.
[in]	branchId	The branch.

返回

Child object or nullptr if not available. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  GetChildren()

Returns all children of the given hierarchy.

参数

[in]

branchId

The branch. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  GetBranches()

Returns all branches of the given hierarchy.

◆  GetBranchId()

Returns the branch the object belongs to.

◆  SetLocking()

Set the locking of an object. If the object is locked it cannot be removed or changed in the hierarchy.

◆  IsLocked()

Get the locking of an object. If the object is locked it cannot be removed or changed in the hierarchy.

返回

True if locked.

◆  GetParent()

Returns the parent of this object. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  GetNext()

Returns the next sibling of this object. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  GetPrev()

Returns the previous sibling of this object. @MAXON_ANNOTATION{interfaceParameter=Interface}

◆  GetFirst()

Returns the first sibling of this chain. If the object is already the first element the object is returned;

◆  GetLast()

Returns the last sibling of this chain. If the object is already the first element the object is returned;

◆  ParentChanged()

Is invoked whenever the parent of this object changes. This method can be overridden when special actions have to be taken on such a change, for example the update of an underlying hierarchy which has to be kept in sync with this hierarchy.

This method must not be invoked by user code.

参数

[in]

removed

Flag if the object has been removed (true) or inserted (false).

◆  FindNextLeaf()

◆  MAXON_OBSERVABLE() [1/2]

ObservableHierarchyInsert is sent whenever an object was inserted in the hierarchy. 注意 : The children and siblings of the object are not sent as an observable!

参数

[in]	sender	Sender object.
[in]	object	HierarchyObject which was added.
[in]	branchId	The branch the object belongs to.

◆  MAXON_OBSERVABLE() [2/2]

ObservableHierarchyRemove is sent whenever an object was removed from the hierarchy. 注意 : The children of the object are not sent as an observable!

参数

[in]	sender	Sender object.
[in]	object	HierarchyObject which was removed.
[in]	branchId	The branch the object belongs to.

• maxon
• HierarchyObjectInterface