HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GA_AttributeOptions Class Reference

#include <GA_Attribute.h>

Public Member Functions

 GA_AttributeOptions ()
 
 ~GA_AttributeOptions ()
 
 GA_AttributeOptions (const GA_AttributeOptions &src)
 
GA_AttributeOptionsoperator= (const GA_AttributeOptions &src)
 
void clear ()
 Reset to default. More...
 
void buildFullOptions (UT_Options &fulloptions) const
 
void extractBuiltinOptions ()
 
UT_OptionscreateOptions ()
 If no custom options are present, create it. More...
 
void mergeOptions (const GA_AttributeOptions &src)
 Merges option list on top of our own. More...
 
bool exportOnMergeSet () const
 
bool exportOnMerge (bool defval=false) const
 
void setExportOnMerge (bool v)
 Set the export on merge flag. More...
 
bool exportOnSaveSet () const
 
bool exportOnSave (bool defval=false) const
 
void setExportOnSave (bool v)
 Set the export on save flag. More...
 
bool isStringSet (bool defval=false) const
 
void setIsStringSet (bool v)
 Set the "string set" flag. More...
 
GA_TypeInfo typeInfo () const
 
void setTypeInfo (GA_TypeInfo t)
 
bool isNonTransforming () const
 
void setIsNonTransforming (bool v)
 
bool exportToInfoBlock () const
 
void setExportToInfoBlock (bool v)
 
bool leaveOnGPU () const
 
void setLeaveOnGPU (bool v)
 
const UT_Optionsoptions () const
 
void setOptions (const UT_Options &o)
 
void mergeOptions (const UT_Options &o)
 
void mergeOptions (const UT_Options &o, bool(*match)(const UT_StringHolder &name, const UT_OptionEntry *, void *), void *data)
 
void clearOptions ()
 
bool removeOption (const char *name)
 

Friends

class GA_Attribute
 

Detailed Description

Definition at line 69 of file GA_Attribute.h.

Constructor & Destructor Documentation

GA_AttributeOptions::GA_AttributeOptions ( )
GA_AttributeOptions::~GA_AttributeOptions ( )
GA_AttributeOptions::GA_AttributeOptions ( const GA_AttributeOptions src)

Member Function Documentation

void GA_AttributeOptions::buildFullOptions ( UT_Options fulloptions) const

Constructs a full UT_Options that includes all symbols that are otherwise handled with member variables.

void GA_AttributeOptions::clear ( )

Reset to default.

void GA_AttributeOptions::clearOptions ( )

Access to options

UT_Options& GA_AttributeOptions::createOptions ( )

If no custom options are present, create it.

bool GA_AttributeOptions::exportOnMerge ( bool  defval = false) const
inline

Check to see whether the export on merge is enabled. If the flag hasn't been set, the default value will be used.

Definition at line 114 of file GA_Attribute.h.

bool GA_AttributeOptions::exportOnMergeSet ( ) const
inline

Check whether the exportOnMerge() flag has been set, or whether it's at its default.

Definition at line 111 of file GA_Attribute.h.

bool GA_AttributeOptions::exportOnSave ( bool  defval = false) const
inline

Check to see whether the export on save is enabled. If the flag hasn't been set, the default value will be used.

Definition at line 128 of file GA_Attribute.h.

bool GA_AttributeOptions::exportOnSaveSet ( ) const
inline

Check whether the exportOnSave() flag has been set, or whether it's at its default.

Definition at line 125 of file GA_Attribute.h.

bool GA_AttributeOptions::exportToInfoBlock ( ) const
inline

Accessors

Definition at line 103 of file GA_Attribute.h.

void GA_AttributeOptions::extractBuiltinOptions ( )

Removes from our myOptions list any options that aren't custom and assigns them to local variables. May then delete myOptions if it is empty.

bool GA_AttributeOptions::isNonTransforming ( ) const
inline

Accessors

Definition at line 101 of file GA_Attribute.h.

bool GA_AttributeOptions::isStringSet ( bool  defval = false) const
inline

Check to see whether the attribute is a "string set". If the flag hasn't been set, the default value will be used.

Definition at line 139 of file GA_Attribute.h.

bool GA_AttributeOptions::leaveOnGPU ( ) const
inline

Accessors

Definition at line 105 of file GA_Attribute.h.

void GA_AttributeOptions::mergeOptions ( const GA_AttributeOptions src)

Merges option list on top of our own.

void GA_AttributeOptions::mergeOptions ( const UT_Options o)

Access to options

void GA_AttributeOptions::mergeOptions ( const UT_Options o,
bool(*)(const UT_StringHolder &name, const UT_OptionEntry *, void *)  match,
void data 
)

Access to options

GA_AttributeOptions& GA_AttributeOptions::operator= ( const GA_AttributeOptions src)
const UT_Options* GA_AttributeOptions::options ( ) const
inline

Access to options

Definition at line 150 of file GA_Attribute.h.

bool GA_AttributeOptions::removeOption ( const char *  name)

Access to options

void GA_AttributeOptions::setExportOnMerge ( bool  v)
inline

Set the export on merge flag.

Definition at line 117 of file GA_Attribute.h.

void GA_AttributeOptions::setExportOnSave ( bool  v)
inline

Set the export on save flag.

Definition at line 131 of file GA_Attribute.h.

void GA_AttributeOptions::setExportToInfoBlock ( bool  v)
inline

Accessors

Definition at line 104 of file GA_Attribute.h.

void GA_AttributeOptions::setIsNonTransforming ( bool  v)
inline

Accessors

Definition at line 102 of file GA_Attribute.h.

void GA_AttributeOptions::setIsStringSet ( bool  v)
inline

Set the "string set" flag.

Definition at line 142 of file GA_Attribute.h.

void GA_AttributeOptions::setLeaveOnGPU ( bool  v)
inline

Accessors

Definition at line 106 of file GA_Attribute.h.

void GA_AttributeOptions::setOptions ( const UT_Options o)

Access to options

void GA_AttributeOptions::setTypeInfo ( GA_TypeInfo  t)
inline

Accessors

Definition at line 100 of file GA_Attribute.h.

GA_TypeInfo GA_AttributeOptions::typeInfo ( ) const
inline

Accessors

Definition at line 99 of file GA_Attribute.h.

Friends And Related Function Documentation

friend class GA_Attribute
friend

Definition at line 178 of file GA_Attribute.h.


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