plywoot::PlyProperty Struct Reference

#include <types.hpp>

Public Member Functions
	PlyProperty ()=default
	Default constructor.
	PlyProperty (std::string name, PlyDataType type)
	PlyProperty (std::string name, PlyDataType type, PlyDataType sizeType)
const std::string &	name () const
PlyDataType	type () const
bool	isList () const
PlyDataType	sizeType () const

Friends
bool	operator== (const PlyProperty &x, const PlyProperty &y)
bool	operator!= (const PlyProperty &x, const PlyProperty &y)

Detailed Description

Represents a PLY property stored in an element. A PLY property is a named data element with a certain type.

Definition at line 80 of file types.hpp.

Constructor & Destructor Documentation

PlyProperty() [1/2]

plywoot::PlyProperty::PlyProperty ( std::string  name, PlyDataType  type  )

inline

Constructs a PLY property for a property with the given name and type.

Parameters

name	name of the PLY property
type	type of the PLY property

Definition at line 88 of file types.hpp.

PlyProperty() [2/2]

plywoot::PlyProperty::PlyProperty ( std::string  name, PlyDataType  type, PlyDataType  sizeType  )

inline

Constructs a PLY list property for a list property with the given name, type, and size type.

Parameters

name	name of the PLY list property
type	type of the elements in the PLY property
sizeType	type of number storing the size of list

Definition at line 95 of file types.hpp.

Member Function Documentation

isList()

bool plywoot::PlyProperty::isList ( ) const

inline

Returns whether this property represents a list property.

Returns

true in case this property represents a list property, false otherwise

Definition at line 112 of file types.hpp.

name()

const std::string & plywoot::PlyProperty::name ( ) const

inline

Returns the name of this property.

Returns

the name of this property

Definition at line 103 of file types.hpp.

sizeType()

PlyDataType plywoot::PlyProperty::sizeType ( ) const

inline

Returns the size type of this property.

Returns

the size type of this property

Definition at line 116 of file types.hpp.

type()

PlyDataType plywoot::PlyProperty::type ( ) const

inline

Returns the type of this property.

Returns

the type of this property

Definition at line 107 of file types.hpp.

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const PlyProperty &  x, const PlyProperty &  y  )

friend

Compares the two given PLY properties x and y for inequality.

Parameters

x	left-hand side property to compare for inequality with y
y	right-hand side property to compare for inequality with x

Returns

true in case x is not equal to y, false otherwise

Definition at line 133 of file types.hpp.

operator==

bool operator== ( const PlyProperty &  x, const PlyProperty &  y  )

friend

Compares the two given PLY properties x and y for equality.

Parameters

x	left-hand side property to compare for equality with y
y	right-hand side property to compare for equality with x

Returns

true in case x is equal to y, false otherwise

Definition at line 123 of file types.hpp.

---

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

• include/plywoot/plywoot/types.hpp