UVWTag Class Reference

#include <c4d_basetag.h>

Inheritance diagram for UVWTag:

Detailed Description

Represents the UVW tag.
Handles the UVW coordinates for textures. When assigning a UVW tag to an object ensure the texture is set to UVW.

Note
Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Public Member Functions

maxon::Range< Vector32CalculateBoundingBox () const
 
- Public Member Functions inherited from VariableTag
Int32 GetDataCount (void) const
 
Int32 GetDataSize (void) const
 
const void * GetLowlevelDataAddressR (void) const
 
void * GetLowlevelDataAddressW (void)
 
- Public Member Functions inherited from BaseTag
Bool Draw (BaseObject *op, BaseDraw *bd, BaseDrawHelp *bh)
 
BaseTagGetNext (void)
 
BaseTagGetPred (void)
 
BaseObjectGetObject (void)
 
BaseTagGetOrigin ()
 
- Public Member Functions inherited from BaseList2D
void SetBit (Int32 mask)
 
Bool GetBit (Int32 mask) const
 
void DelBit (Int32 mask)
 
void ToggleBit (Int32 mask)
 
Int32 GetAllBits () const
 
void SetAllBits (Int32 bits)
 
void SetBitEx (Int32 mask, Int32 flags)
 
const CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
 
BaseList2DGetNext ()
 
BaseList2DGetPred ()
 
BaseContainer GetData ()
 
void SetData (const BaseContainer &bc, Bool add=true)
 
const BaseContainerGetDataInstance () const
 
BaseContainerGetDataInstance ()
 
const BaseContainerGetDataInstanceRef () const
 
BaseContainerGetDataInstanceRef ()
 
String GetName () const
 
void SetName (const maxon::String &name)
 
String GetBubbleHelp ()
 
Bool TransferGoal (BaseList2D *dst, Bool undolink)
 
Bool TransferMarker (BaseList2D *dst) const
 
Bool Scale (Float scale)
 
Bool Edit ()
 
void GetIcon (IconData *dat)
 
GeListHeadGetNLARoot ()
 
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
 
String GetTypeName ()
 
BaseList2DGetMain () const
 
void InsertTrackSorted (CTrack *track)
 
Bool AddEventNotification (BaseList2D *bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer *data)
 
Bool RemoveEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
 
Bool FindEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
 
Bool SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
 
DESCIDSTATE GetDescIDState (const DescID &id, Bool tolerant) const
 
GeListHeadGetOverrideRoot ()
 
BaseOverrideGetFirstOverride ()
 
GeListHeadGetShaderRepositoryRoot ()
 
GeListHeadGetHiddenShaderRoot ()
 
maxon::NimbusForwardRef GetNimbusRef (const maxon::Id &spaceId) const
 
maxon::Result< maxon::NimbusForwardRefPrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)
 
void RemoveNimbusRef (const maxon::Id &spaceId)
 
maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > > GetAllNimbusRefs () const
 
Bool IsNodeBased () const
 
void GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
 
const GeMarkerGetMarker () const
 
void SetMarker (const GeMarker &m)
 
Bool AddUniqueID (Int32 appid, const Char *const mem, Int bytes)
 
Bool FindUniqueID (Int32 appid, const Char *&mem, Int &bytes) const
 
Int32 GetUniqueIDCount () const
 
Bool GetUniqueIDIndex (Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const
 
Bool SetAnimatedParameter (CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)
 
Bool GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags)
 
BaseShaderGetFirstShader () const
 
void InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
 
void ClearKeyframeSelection ()
 
Bool FindKeyframeSelection (const DescID &id)
 
Bool SetKeyframeSelection (const DescID &id, Bool selection)
 
Bool KeyframeSelectionContent ()
 
LayerObjectGetLayerObject (BaseDocument *doc)
 
Bool SetLayerObject (LayerObject *layer)
 
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
GeListHeadGetCTrackRoot ()
 
CTrackGetFirstCTrack ()
 
CTrackFindCTrack (const DescID &id)
 
- Public Member Functions inherited from GeListNode
GeListNodeGetNext ()
 
GeListNodeGetPred ()
 
GeListNodeGetDown ()
 
GeListNodeGetUp ()
 
GeListNodeGetDownLast ()
 
void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove ()
 
GeListHeadGetListHead ()
 
Int32 GetNodeID (Int32 index=0) const
 
template<typename CAST >
const CAST * GetNodeData (Int32 index=0) const
 
template<typename CAST >
CAST * GetNodeData (Int32 index=0)
 
void SetCustomData (GeListNode *node)
 
GeListNodeGetCustomData ()
 
BaseDocumentGetDocument ()
 
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
 
Bool IsDocumentRelated ()
 
Int32 GetInfo ()
 
Bool GetNBit (NBIT bit) const
 
UInt32 GetNBitMask (Int32 index) const
 
Bool ChangeNBit (NBIT bit, NBITCONTROL bitmode)
 
- Public Member Functions inherited from C4DAtom
Int32 GetType () const
 
Int32 GetRealType () const
 
Int32 GetDiskType () const
 
Bool IsInstanceOf (Int32 id) const
 
Int32 GetClassification () const
 
Bool Message (Int32 type, void *data=nullptr)
 
Bool MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)
 
C4DAtomGetClone (COPYFLAGS flags, AliasTrans *trn)
 
Bool CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
 
Bool Read (HyperFile *hf, Int32 id, Int32 level)
 
Bool Write (HyperFile *hf)
 
Bool ReadObject (HyperFile *hf, Bool readheader)
 
Bool WriteObject (HyperFile *hf)
 
Bool GetDescription (Description *description, DESCFLAGS_DESC flags)
 
Bool GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
 
Bool SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
 
DynamicDescriptionGetDynamicDescription ()
 
Bool GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
 
Bool TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)
 
UInt32 GetDirty (DIRTYFLAGS flags) const
 
void SetDirty (DIRTYFLAGS flags)
 
UInt32 GetHDirty (HDIRTYFLAGS mask) const
 
void SetHDirty (HDIRTYFLAGS mask)
 

Private Member Functions

 UVWTag ()
 
 ~UVWTag ()
 

Alloc/Free

static UVWTagAlloc (Int32 count)
 
static void Free (UVWTag *&bl)
 

Get/Set/Copy UVWHandle

static void Get (ConstUVWHandle dataptr, Int32 i, UVWStruct &res)
 
static void Get (ConstUVWHandle dataptr, Int32 i, SUVWStruct &res)
 
static void Set (UVWHandle dataptr, Int32 i, const UVWStruct &s)
 
static void Copy (UVWHandle destptr, Int32 dst, ConstUVWHandle srcptr, Int32 src)
 

Get/Set/Copy UVW Coordinates/Data

UVWStruct GetSlow (Int32 i)
 
void SetSlow (Int32 i, const UVWStruct &s)
 
void CpySlow (Int32 dst, UVWTag *srctag, Int32 src)
 
ConstUVWHandle GetDataAddressR (void) const
 
UVWHandle GetDataAddressW (void)
 

Operations on the Pin Point Selection

void ClearPinSelection ()
 
Bool SetPinSelection (const BaseSelect &pinSelection)
 
BaseSelectGetPinSelection ()
 
const BaseSelectGetPinSelection () const
 
Bool AddToPinSelection (const BaseSelect &pinSelection)
 
Bool RemoveFromPinSelection (const BaseSelect &pinSelection)
 

Additional Inherited Members

- Static Public Member Functions inherited from VariableTag
static VariableTagAlloc (Int32 type, Int32 count)
 
static void Free (VariableTag *&bl)
 
- Static Public Member Functions inherited from BaseTag
static BaseTagAlloc (Int32 type)
 
static void Free (BaseTag *&bl)
 
- Static Public Member Functions inherited from BaseList2D
static BaseList2DAlloc (Int32 type)
 
static void Free (BaseList2D *&bl)
 
- Static Public Attributes inherited from BaseList2D
static const Int32 SETBIT_FLAG_NODIRTY
 
static const Int32 SETBIT_FLAG_REMOVE
 

Constructor & Destructor Documentation

◆ UVWTag()

UVWTag ( )
private

◆ ~UVWTag()

~UVWTag ( )
private

Member Function Documentation

◆ Alloc()

static UVWTag* Alloc ( Int32  count)
static

Allocates a UVW tag. Destroy the allocated UVW tag with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters
[in]countThe number of UVW element data.
Returns
The allocated UVW tag, or nullptr if the allocation failed.

◆ Free()

static void Free ( UVWTag *&  bl)
static

Destructs UVW tags allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters
[in,out]blThe UVW tag to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ GetSlow()

UVWStruct GetSlow ( Int32  i)

Gets the UVW coordinates for a polygon.

Parameters
[in]iThe index of the polygon to get the coordinates for.
Returns
The UVW coordinates.

◆ SetSlow()

void SetSlow ( Int32  i,
const UVWStruct s 
)

Sets the UVW coordinates for a polygon.

Parameters
[in]iThe index of the polygon to set the coordinates for.
[in]sThe UVW coordinates for each point of the polygon.

◆ CpySlow()

void CpySlow ( Int32  dst,
UVWTag srctag,
Int32  src 
)

Copies a UVW coordinate.

Parameters
[in]dstThe destination polygon index in the UVWTag.
[in]srctagThe UVW tag for the source polygon. The caller owns the pointed tag.
[in]srcThe source polygon index in the source UVW tag srctag.

◆ GetDataAddressR()

ConstUVWHandle GetDataAddressR ( void  ) const

Gets a handle to the read-only UVW data.

Returns
The read-only UVW data. The tag owns the pointed UVW data.

◆ GetDataAddressW()

UVWHandle GetDataAddressW ( void  )

Gets a handle to the writable UVW data.

Returns
The writable UVW data. The tag owns the pointed UVW data.

◆ CalculateBoundingBox()

maxon::Range<Vector32> CalculateBoundingBox ( ) const

Calculates the bounding box of the UVW data. @markPrivate

◆ Get() [1/2]

static void Get ( ConstUVWHandle  dataptr,
Int32  i,
UVWStruct res 
)
static

Gets the UVW coordinates for a polygon. Example:

Int32 dataCount = uvwTag->GetDataCount();
ConstUVWHandle data = uvwTag->GetDataAddressR();
for (Int32 i=0; i<dataCount; i++)
{
UVWTag::Get(data, i, res);
// Do something with 'res'
}
static void Get(ConstUVWHandle dataptr, Int32 i, UVWStruct &res)
Definition: c4d_basetag.h:469
maxon::Int32 Int32
Definition: ge_sys_math.h:60
const void * ConstUVWHandle
Handle for read-only UVW data. See also: UVWTag.
Definition: operatingsystem.h:458
Definition: operatingsystem.h:469
Parameters
[in]dataptrThe handle to the UVW data.
[in]iThe index of the polygon to get the coordinates for.
[out]resAssigned the UVW coordinates for the polygon.

◆ Get() [2/2]

static void Get ( ConstUVWHandle  dataptr,
Int32  i,
SUVWStruct res 
)
static

Gets the UVW coordinates for a polygon. Example:

Int32 dataCount = uvwTag->GetDataCount();
ConstUVWHandle data = uvwTag->GetDataAddressR();
for (Int32 i=0; i<dataCount; i++)
{
UVWTag::Get(data, i, res);
// Do something with 'res'
}
Definition: operatingsystem.h:533
Parameters
[in]dataptrThe handle to the UVW data.
[in]iThe index of the polygon to get the coordinates for.
[out]resAssigned the UVW coordinates for the polygon.

◆ Set()

static void Set ( UVWHandle  dataptr,
Int32  i,
const UVWStruct s 
)
static

Sets the UVW coordinates for a polygon.

Parameters
[in]dataptrThe handle to the UVW data.
[in]iThe index of the polygon to set the coordinates for.
[in]sThe UVW coordinates for the polygon.

◆ Copy()

static void Copy ( UVWHandle  destptr,
Int32  dst,
ConstUVWHandle  srcptr,
Int32  src 
)
static

Copies UVW coordinates.

Parameters
[in]destptrThe handle to the destination UVW data.
[in]dstThe destination polygon index in the destination UVW data destptr.
[in]srcptrThe handle to the source UVW data.
[in]srcThe source polygon index in the source UVW data srcptr.

◆ ClearPinSelection()

void ClearPinSelection ( )

Clears the pin point selection for this tag.

◆ SetPinSelection()

Bool SetPinSelection ( const BaseSelect pinSelection)

Replaces the pin point selection for this tag with the point selection specified.

Parameters
[in]pinSelectionNew pin selection to set.
Returns
True on success.

◆ GetPinSelection() [1/2]

BaseSelect& GetPinSelection ( )

Obtains the current pin point selection for this tag.

Returns
Reference to the pin selection.

◆ GetPinSelection() [2/2]

const BaseSelect& GetPinSelection ( ) const

Obtains the current pin point selection for this tag.

Returns
A non-writable reference to the pin selection.

◆ AddToPinSelection()

Bool AddToPinSelection ( const BaseSelect pinSelection)

Adds the point selection specified to the pin point selection.

Parameters
[in]pinSelectionPin selection to add.
Returns
True on success.

◆ RemoveFromPinSelection()

Bool RemoveFromPinSelection ( const BaseSelect pinSelection)

Removes from the pin point selection the points in the selection specified. Points in the specified selection that are not part of the current pin point selection are simply ignored.

Parameters
[in]pinSelectionPin point selection to remove.
Returns
True on success.