3ds Max C++ API Reference
Loading...
Searching...
No Matches
IShapeRectRenderParams Class Reference

Rectangular Shape Render Parameters API This interface gives access to the new Renderable SPline parameters for Rectangular Shapes The IShapeRectRenderParams interface can be retrieved like this: IShapeRectRenderParams* rparams = (IShapeRectRenderParams*)obj->GetProperty(SHAPE_RECT_RENDERPARAMS_PROPID); Note that this interface contains VPT and non VPT parameters. More...

#include <object.h>

+ Inheritance diagram for IShapeRectRenderParams:

Public Member Functions

 IShapeRectRenderParams (ShapeObject *so)
 Constructor.
 
CoreExport BOOL GetRectangular (TimeValue t) const
 Gets the Rectangular setting of the shape.
 
CoreExport void SetRectangular (TimeValue t, BOOL rectangular)
 Sets the Rectangular setting of the shape.
 
CoreExport float GetWidth (TimeValue t) const
 Gets the Width of the rectangular section of the shape.
 
CoreExport void SetWidth (TimeValue t, float width)
 Sets the Width of the rectangular section of the shape.
 
CoreExport float GetLength (TimeValue t) const
 Gets the Length of the rectangular section of the shape.
 
CoreExport void SetLength (TimeValue t, float length)
 Sets the Length of the rectangular section of the shape.
 
CoreExport float GetAngle2 (TimeValue t) const
 Gets the Angle of the rectangular section of the shape.
 
CoreExport void SetAngle2 (TimeValue t, float angle)
 Sets the Angle of the rectangular section of the shape.
 
CoreExport BOOL GetAspectLock (TimeValue t) const
 Gets the AspectLock parameter of the rectangular section of the shape.
 
CoreExport void SetAspectLock (TimeValue t, BOOL aspectLock)
 Sets the AspectLock parameter of the rectangular section of the shape.
 
CoreExport BOOL GetVPTRectangular (TimeValue t) const
 Gets the Rectangular setting of the shape for the viewport.
 
CoreExport void SetVPTRectangular (TimeValue t, BOOL rectangular)
 Sets the Rectangular parameter of the rectangular section of the shape for the viewport.
 
CoreExport float GetVPTWidth (TimeValue t) const
 Gets the Width of the rectangular section of the shape for the viewport.
 
CoreExport void SetVPTWidth (TimeValue t, float width)
 Sets the Width of the rectangular section of the shape for the viewport.
 
CoreExport float GetVPTLength (TimeValue t) const
 Gets the Length of the rectangular section of the shape for the viewport.
 
CoreExport void SetVPTLength (TimeValue t, float length)
 Sets the Length of the rectangular section of the shape for the viewport.
 
CoreExport float GetVPTAngle2 (TimeValue t) const
 Gets the Angle of the rectangular section of the shape for the viewport.
 
CoreExport void SetVPTAngle2 (TimeValue t, float angle)
 Sets the Angle of the rectangular section of the shape for the viewport.
 
CoreExport BOOL GetVPTAspectLock (TimeValue t) const
 Gets the AspectLock parameter of the rectangular section of the shape for the viewport.
 
CoreExport void SetVPTAspectLock (TimeValue t, BOOL aspectLock)
 Sets the AspectLock parameter of the rectangular section of the shape for the viewport.
 
CoreExport BOOL GetAutosmooth (TimeValue t) const
 Gets the AutoSmooth parameter of the shape.
 
CoreExport void SetAutosmooth (TimeValue t, BOOL autosmooth)
 Sets the AutoSmooth parameter of the shape for the viewport.
 
CoreExport float GetAutosmoothThreshold (TimeValue t) const
 Gets the AutoSmooth Threshold of the shape.
 
CoreExport void SetAutosmoothThreshold (TimeValue t, float threshold)
 Sets the AutoSmooth Threshold of the shape.
 
DWORD ID () override
 ID of this AnimProperty.
 
- Public Member Functions inherited from AnimProperty
virtual BOOL DontDelete ()
 
virtual ~AnimProperty ()
 
virtual DWORD ID ()=0
 

Protected Attributes

ShapeObjectmShape
 

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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator.
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator.
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary.
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
 

Detailed Description

Rectangular Shape Render Parameters API This interface gives access to the new Renderable SPline parameters for Rectangular Shapes The IShapeRectRenderParams interface can be retrieved like this: IShapeRectRenderParams* rparams = (IShapeRectRenderParams*)obj->GetProperty(SHAPE_RECT_RENDERPARAMS_PROPID); Note that this interface contains VPT and non VPT parameters.

The non VPT parameters are used for the renderer and the viewport in case GetViewportOrRenderer() returns true, or if GetViewportOrRenderer() returns false and GetUseViewPort() returns false. Otherwise the non vpt settings only control the mesh for the renderer, not the viewport.

Constructor & Destructor Documentation

◆ IShapeRectRenderParams()

Constructor.

Parameters
so- ShapeObject that publishes this interface
4383 : mShape(so)
4384 {
4385 }
ShapeObject * mShape
Definition: object.h:4379

Member Function Documentation

◆ GetRectangular()

CoreExport BOOL GetRectangular ( TimeValue  t) const

Gets the Rectangular setting of the shape.

Parameters
t- Time to get the value for
Returns
Rectangular setting of the shape

◆ SetRectangular()

CoreExport void SetRectangular ( TimeValue  t,
BOOL  rectangular 
)

Sets the Rectangular setting of the shape.

Parameters
t- Time to set the value for
rectangular- if true, shape is rectangular, if false radial

◆ GetWidth()

CoreExport float GetWidth ( TimeValue  t) const

Gets the Width of the rectangular section of the shape.

Parameters
t- Time to get the value for
Returns
Width of the rectangular section of the shape

◆ SetWidth()

CoreExport void SetWidth ( TimeValue  t,
float  width 
)

Sets the Width of the rectangular section of the shape.

Parameters
t- Time to set the value for
width- Width Value (must be positive)

◆ GetLength()

CoreExport float GetLength ( TimeValue  t) const

Gets the Length of the rectangular section of the shape.

Parameters
t- Time to get the value for
Returns
Length of the rectangular section of the shape

◆ SetLength()

CoreExport void SetLength ( TimeValue  t,
float  length 
)

Sets the Length of the rectangular section of the shape.

Parameters
t- Time to set the value for
length- Length Value (must be positive)

◆ GetAngle2()

CoreExport float GetAngle2 ( TimeValue  t) const

Gets the Angle of the rectangular section of the shape.

Parameters
t- Time to get the value for
Returns
Angle of the rectangular section of the shape

◆ SetAngle2()

CoreExport void SetAngle2 ( TimeValue  t,
float  angle 
)

Sets the Angle of the rectangular section of the shape.

Parameters
t- Time to set the value for
angle- Angle Value for rectangular shape

◆ GetAspectLock()

CoreExport BOOL GetAspectLock ( TimeValue  t) const

Gets the AspectLock parameter of the rectangular section of the shape.

Parameters
t- Time to get the value for
Returns
AspectLock parameter of the rectangular section of the shape

◆ SetAspectLock()

CoreExport void SetAspectLock ( TimeValue  t,
BOOL  aspectLock 
)

Sets the AspectLock parameter of the rectangular section of the shape.

Parameters
t- Time to set the value for
aspectLock- TRUE if aspect is locked, FALSE otherwise

◆ GetVPTRectangular()

CoreExport BOOL GetVPTRectangular ( TimeValue  t) const

Gets the Rectangular setting of the shape for the viewport.

Parameters
t- Time to get the value for
Returns
Rectangular setting of the shape for the viewport

◆ SetVPTRectangular()

CoreExport void SetVPTRectangular ( TimeValue  t,
BOOL  rectangular 
)

Sets the Rectangular parameter of the rectangular section of the shape for the viewport.

Parameters
t- Time to set the value for
rectangular- if true, shape is rectangular, if false radial

◆ GetVPTWidth()

CoreExport float GetVPTWidth ( TimeValue  t) const

Gets the Width of the rectangular section of the shape for the viewport.

Parameters
t- Time to get the value for
Returns
Width of the rectangular section of the shape for the viewport

◆ SetVPTWidth()

CoreExport void SetVPTWidth ( TimeValue  t,
float  width 
)

Sets the Width of the rectangular section of the shape for the viewport.

Parameters
t- Time to set the value for
width- Width Value (must be positive)

◆ GetVPTLength()

CoreExport float GetVPTLength ( TimeValue  t) const

Gets the Length of the rectangular section of the shape for the viewport.

Parameters
t- Time to get the value for
Returns
Length of the rectangular section of the shape for the viewport

◆ SetVPTLength()

CoreExport void SetVPTLength ( TimeValue  t,
float  length 
)

Sets the Length of the rectangular section of the shape for the viewport.

Parameters
t- Time to set the value for
length- Length Value (must be positive)

◆ GetVPTAngle2()

CoreExport float GetVPTAngle2 ( TimeValue  t) const

Gets the Angle of the rectangular section of the shape for the viewport.

Parameters
t- Time to get the value for
Returns
Angle of the rectangular section of the shape for the viewport

◆ SetVPTAngle2()

CoreExport void SetVPTAngle2 ( TimeValue  t,
float  angle 
)

Sets the Angle of the rectangular section of the shape for the viewport.

Parameters
t- Time to set the value for
angle- Angle Value for rectangular shape

◆ GetVPTAspectLock()

CoreExport BOOL GetVPTAspectLock ( TimeValue  t) const

Gets the AspectLock parameter of the rectangular section of the shape for the viewport.

Parameters
t- Time to get the value for
Returns
AspectLock parameter of the rectangular section of the shape for the viewport

◆ SetVPTAspectLock()

CoreExport void SetVPTAspectLock ( TimeValue  t,
BOOL  aspectLock 
)

Sets the AspectLock parameter of the rectangular section of the shape for the viewport.

Parameters
t- Time to set the value for
aspectLock- TRUE if aspect is locked, FALSE otherwise

◆ GetAutosmooth()

CoreExport BOOL GetAutosmooth ( TimeValue  t) const

Gets the AutoSmooth parameter of the shape.

Parameters
t- Time to get the value for
Returns
AutoSmooth parameter of the shape

◆ SetAutosmooth()

CoreExport void SetAutosmooth ( TimeValue  t,
BOOL  autosmooth 
)

Sets the AutoSmooth parameter of the shape for the viewport.

Parameters
t- Time to set the value for
autosmooth- TRUE if resulting mesh should be autosmoothed, FALSE otherwise

◆ GetAutosmoothThreshold()

CoreExport float GetAutosmoothThreshold ( TimeValue  t) const

Gets the AutoSmooth Threshold of the shape.

Parameters
t- Time to get the value for
Returns
AutoSmooth Threshold of the shape

◆ SetAutosmoothThreshold()

CoreExport void SetAutosmoothThreshold ( TimeValue  t,
float  threshold 
)

Sets the AutoSmooth Threshold of the shape.

Parameters
t- Time to set the value for
threshold- threashold angle in radians

◆ ID()

DWORD ID ( )
inlineoverridevirtual

ID of this AnimProperty.

Returns
ID of this AnimProperty

Implements AnimProperty.

#define SHAPE_RECT_RENDERPARAMS_PROPID
Definition: object.h:4367

Member Data Documentation

◆ mShape

ShapeObject* mShape
protected