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

Class representing a file in the file map. More...

#include <GU_PackedFolders.h>

Public Member Functions

const UT_StringHolderpath () const
 Path that this file represents. More...
 
bool treatAsFolder () const
 
bool isFolder () const
 Return true if we're the root or treatAsFolder() More...
 
bool isParentEmpty () const
 
bool isParentPrim () const
 
bool isParentRange () const
 
GU_PrimPackedparentPrim ()
 
const GU_PrimPackedparentPrim () const
 
GU_PrimPackedgetIfParentPrim ()
 
const GU_PrimPackedgetIfParentPrim () const
 
GA_RangeparentRange ()
 
const GA_RangeparentRange () const
 
GU_DetailHandle safePrimGdhNC ()
 
GU_ConstDetailHandle primGdh () const
 
void setPrimGdh (const GU_ConstDetailHandle &prim_gdh)
 
bool isExisting () const
 
void setExisting (bool f)
 
bool isModified () const
 
void setModified (bool f)
 
bool isTouched () const
 
void setTouched (bool f)
 
bool isCleared () const
 
void setCleared (bool f)
 
bool isVisible () const
 
void setVisible (bool f)
 

Friends

class GU_PackedFolders
 

Detailed Description

Class representing a file in the file map.

Definition at line 223 of file GU_PackedFolders.h.

Member Function Documentation

GU_PrimPacked* GU_PackedFolders::FileInfo::getIfParentPrim ( )
inline

Get parent as a packed primitive, returns nullptr if not a prim

Definition at line 262 of file GU_PackedFolders.h.

const GU_PrimPacked* GU_PackedFolders::FileInfo::getIfParentPrim ( ) const
inline

Get parent as a packed primitive, returns nullptr if not a prim

Definition at line 267 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::isCleared ( ) const
inline

Flag accessors

Definition at line 342 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::isExisting ( ) const
inline

Flag accessors

Definition at line 333 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::isFolder ( ) const
inline

Return true if we're the root or treatAsFolder()

Definition at line 297 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::isModified ( ) const
inline

Flag accessors

Definition at line 336 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::isParentEmpty ( ) const
inline

The parent can be in one of three states

Definition at line 232 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::isParentPrim ( ) const
inline

The parent can be in one of three states

Definition at line 236 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::isParentRange ( ) const
inline

The parent can be in one of three states

Definition at line 240 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::isTouched ( ) const
inline

Flag accessors

Definition at line 339 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::isVisible ( ) const
inline

Flag accessors

Definition at line 345 of file GU_PackedFolders.h.

GU_PrimPacked* GU_PackedFolders::FileInfo::parentPrim ( )
inline

Obtain parent as a GU_PrimPacked*, throws if !isParentPrim()

Definition at line 248 of file GU_PackedFolders.h.

const GU_PrimPacked* GU_PackedFolders::FileInfo::parentPrim ( ) const
inline

Obtain parent as a GU_PrimPacked*, throws if !isParentPrim()

Definition at line 253 of file GU_PackedFolders.h.

GA_Range& GU_PackedFolders::FileInfo::parentRange ( )
inline

Get parent as a GA_Range, throws if !isParentRange()

Definition at line 276 of file GU_PackedFolders.h.

const GA_Range& GU_PackedFolders::FileInfo::parentRange ( ) const
inline

Get parent as a GA_Range, throws if !isParentRange()

Definition at line 281 of file GU_PackedFolders.h.

const UT_StringHolder& GU_PackedFolders::FileInfo::path ( ) const
inline

Path that this file represents.

Definition at line 228 of file GU_PackedFolders.h.

GU_ConstDetailHandle GU_PackedFolders::FileInfo::primGdh ( ) const
inline

Safe accessors to GU_ConstDetailHandle/GU_DetailHandle of file contents

Definition at line 310 of file GU_PackedFolders.h.

GU_DetailHandle GU_PackedFolders::FileInfo::safePrimGdhNC ( )
inline

Safe accessors to GU_ConstDetailHandle/GU_DetailHandle of file contents

Definition at line 304 of file GU_PackedFolders.h.

void GU_PackedFolders::FileInfo::setCleared ( bool  f)
inline

Flag accessors

Definition at line 343 of file GU_PackedFolders.h.

void GU_PackedFolders::FileInfo::setExisting ( bool  f)
inline

Flag accessors

Definition at line 334 of file GU_PackedFolders.h.

void GU_PackedFolders::FileInfo::setModified ( bool  f)
inline

Flag accessors

Definition at line 337 of file GU_PackedFolders.h.

void GU_PackedFolders::FileInfo::setPrimGdh ( const GU_ConstDetailHandle prim_gdh)
inline

Safe accessors to GU_ConstDetailHandle/GU_DetailHandle of file contents

Definition at line 328 of file GU_PackedFolders.h.

void GU_PackedFolders::FileInfo::setTouched ( bool  f)
inline

Flag accessors

Definition at line 340 of file GU_PackedFolders.h.

void GU_PackedFolders::FileInfo::setVisible ( bool  f)
inline

Flag accessors

Definition at line 346 of file GU_PackedFolders.h.

bool GU_PackedFolders::FileInfo::treatAsFolder ( ) const
inline

Return true if parent is a packed primitive and has treatasfolder intrinsic enabled

Definition at line 290 of file GU_PackedFolders.h.

Friends And Related Function Documentation

friend class GU_PackedFolders
friend

Definition at line 350 of file GU_PackedFolders.h.


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