Foundry::Katana::GroupAttribute Class Reference

A class representing a group attribute, used for hierarchically encapsulating other attributes. More...

#include <FnAttribute.h>

Inheritance diagram for Foundry::Katana::GroupAttribute:

List of all members.

Public Member Functions
	GroupAttribute ()
int64_t	getNumberOfChildren () const
std::string	getChildName (int64_t index) const
const char *	getChildNameCStr (int64_t index) const &
const char *	getChildNameCStr (int64_t index, int32_t &namelen) const &
FnPlatform::StringView	getChildNameStringView (int64_t index) const &
Attribute	getChildByIndex (int64_t index) const
Attribute	getChildByName (FnPlatform::StringView name) const
Attribute	getChildByName (const char *name, int32_t length) const
Static Public Member Functions
static FnKatAttributeType	getKatAttributeType ()

---

Detailed Description

A class representing a group attribute, used for hierarchically encapsulating other attributes.

---

Constructor & Destructor Documentation

Foundry::Katana::GroupAttribute::GroupAttribute

(

)

[inline]

Create empty attribute class (isValid() == false).

---

Member Function Documentation

Attribute Foundry::Katana::GroupAttribute::getChildByIndex

(

int64_t

index

)

const [inline]

Returns a child attribute by index within a group attribute. If index is out of range, an invalid Attribute object is returned (returnValue.isValid() == false).

Parameters:

index

The index of the child attribute to return.

Referenced by Foundry::Katana::ViewerAPI::PickedAttrsMap::fromGroupAttribute().

Attribute Foundry::Katana::GroupAttribute::getChildByName	(	const char *	name,
		int32_t	length
	)		const [inline]

Looks up a child attribute by name, returning it If named child does not exist, an invalid Attribute object is returned (returnValue.isValid() == false).

Parameters:

name	The name of attribute to look up.
length	The length of the string to look up.

Attribute Foundry::Katana::GroupAttribute::getChildByName

(

FnPlatform::StringView

name

)

const [inline]

Looks up a child attribute by name, returning it If named child does not exist, an invalid Attribute object is returned (returnValue.isValid() == false).

Parameters:

name	The name of attribute to look up.

Referenced by GLTranslateManipulator::matches(), GLScaleManipulator::matches(), GLRotateManipulator::matches(), and GLCoiManipulator::matches().

std::string Foundry::Katana::GroupAttribute::getChildName

(

int64_t

index

)

const [inline]

Returns the name of child at index under a group attribute. This is returned as a std::string. If index is out of range, an empty string is returned.

Parameters:

index

The index of the child name to return.

Referenced by Foundry::Katana::ViewerAPI::PickedAttrsMap::fromGroupAttribute().

const char* Foundry::Katana::GroupAttribute::getChildNameCStr

(

int64_t

index

)

const [inline]

Returns the name of child at index under a group attribute. This is returned as a const char *.

Parameters:

index

The index of the child name to return.

References Foundry::Katana::pystring_v1::index().

const char* Foundry::Katana::GroupAttribute::getChildNameCStr	(	int64_t	index,
		int32_t &	namelen
	)		const [inline]

Returns the name of child at index under a group attribute. This is returned as a const char *. The length is also returned.

Parameters:

index	The index of the child name to return.
namelen	Output parameter where the name length is returned.

References Foundry::Katana::pystring_v1::index().

FnPlatform::StringView Foundry::Katana::GroupAttribute::getChildNameStringView

(

int64_t

index

)

const [inline]

Returns the name of child at index under a group attribute. This is returned as a FnPlatform::StringView, containing the data and length.

Parameters:

index

The index of the child name to return.

References Foundry::Katana::pystring_v1::index().

static FnKatAttributeType Foundry::Katana::GroupAttribute::getKatAttributeType

(

)

[inline, static]

Returns the intended type of this Attribute, without needing a valid handle.

int64_t Foundry::Katana::GroupAttribute::getNumberOfChildren

(

)

const [inline]

Returns the number of child attributes under the group attribute.

Referenced by Foundry::Katana::ViewerAPI::PickedAttrsMap::fromGroupAttribute().

---

The documentation for this class was generated from the following file:

• FnAttribute.h