3ds Max C++ API Reference
PolyPt Class Reference

Represents a single point of a PolyLine. More...

#include <polyshp.h>

+ Inheritance diagram for PolyPt:

Public Member Functions

 PolyPt ()
 Constructor. More...
 
 PolyPt (Point3 ip, DWORD f=0, int a=0, DWORD f2=0)
 Constructor. More...
 
MtlID GetMatID () const
 Gets the material ID on a per-segment basis within the spline or polyline. More...
 
void SetMatID (MtlID id)
 Sets the material ID on a per-segment basis within the spline or polyline. More...
 

Public Attributes

Point3 p
 The location of the point. More...
 
DWORD flags
 See Predefined PolyPt Flags. More...
 
DWORD flags2
 See Predefined PolyPt flags2. More...
 
int aux
 Auxiliary data attached to this point (usually mesh vertex number for capping) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 

Detailed Description

Represents a single point of a PolyLine.

All methods of this class are implemented by the system.

See also
PolyLine

Constructor & Destructor Documentation

◆ PolyPt() [1/2]

PolyPt ( )
inline

Constructor.

All data members are initiated to their corresponding zero values.

152  {
153  p = Point3(0, 0, 0);
154  flags = 0;
155  flags2 = 0;
156  aux = 0;
157  }
Definition: point3.h:56
int aux
Auxiliary data attached to this point (usually mesh vertex number for capping)
Definition: polyshp.h:148
DWORD flags
See Predefined PolyPt Flags.
Definition: polyshp.h:146
DWORD flags2
See Predefined PolyPt flags2.
Definition: polyshp.h:147
Point3 p
The location of the point.
Definition: polyshp.h:145

◆ PolyPt() [2/2]

PolyPt ( Point3  ip,
DWORD  f = 0,
int  a = 0,
DWORD  f2 = 0 
)
inline

Constructor.

All data members are initialized to the input data.

161  {
162  p = ip;
163  flags = f;
164  aux = a;
165  flags2 = f2;
166  }

Member Function Documentation

◆ GetMatID()

MtlID GetMatID ( ) const
inline

Gets the material ID on a per-segment basis within the spline or polyline.

171  {
172  return (int)((flags2 >> POLYPT_MATID_SHIFT) & POLYPT_MATID_MASK);
173  }
#define POLYPT_MATID_SHIFT
Definition: polyshp.h:132
#define POLYPT_MATID_MASK
Definition: polyshp.h:133

◆ SetMatID()

void SetMatID ( MtlID  id)
inline

Sets the material ID on a per-segment basis within the spline or polyline.

Parameters
idThe ID to set to.
179  {
180  flags2 &= 0xFFFF;
181  flags2 |= (DWORD)(id << POLYPT_MATID_SHIFT);
182  }

Member Data Documentation

◆ p

Point3 p

The location of the point.

◆ flags

DWORD flags

◆ flags2

DWORD flags2

◆ aux

int aux

Auxiliary data attached to this point (usually mesh vertex number for capping)