HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GU_PackedFoldersRO::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
 
const GU_PrimPackedparentPrim () const
 
const GU_PrimPackedgetIfParentPrim () const
 
const GA_RangeparentRange () const
 
const GU_ConstDetailHandleprimGdh () const
 
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_PackedFoldersRO
 

Detailed Description

Class representing a file in the file map.

Definition at line 31 of file GU_PackedFolders.h.

Member Function Documentation

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

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

Definition at line 64 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 106 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 97 of file GU_PackedFolders.h.

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

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

Definition at line 85 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 100 of file GU_PackedFolders.h.

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

The parent can be in one of three states

Definition at line 40 of file GU_PackedFolders.h.

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

The parent can be in one of three states

Definition at line 44 of file GU_PackedFolders.h.

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

The parent can be in one of three states

Definition at line 48 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 103 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 109 of file GU_PackedFolders.h.

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

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

Definition at line 56 of file GU_PackedFolders.h.

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

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

Definition at line 74 of file GU_PackedFolders.h.

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

Path that this file represents.

Definition at line 36 of file GU_PackedFolders.h.

const GU_ConstDetailHandle& GU_PackedFoldersRO::FileInfo::primGdh ( ) const
inline

Accessor to GU_DetailHandle of file contents

Definition at line 92 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 107 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 98 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 101 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 104 of file GU_PackedFolders.h.

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

Flag accessors

Definition at line 110 of file GU_PackedFolders.h.

SYS_FORCE_INLINE bool GU_PackedFoldersRO::FileInfo::treatAsFolder ( ) const

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

Definition at line 497 of file GU_PackedFolders.h.

Friends And Related Function Documentation

friend class GU_PackedFoldersRO
friend

Definition at line 114 of file GU_PackedFolders.h.


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