ModuleSceneItem Class Reference

Inheritance diagram for ModuleSceneItem:

Public Types
enum	Space {   SPACE_LOCAL,   SPACE_GLOBAL }
enum	VisibilityMode {   VISIBILITY_MODE_OVERRIDE = 0,   VISIBILITY_MODE_USE_PROPERTY,   VISIBILITY_MODE_USE_PREFERENCES,   VISIBILITY_MODE_COUNT }
	VisibilityMode describes how driven visibility attributes are set. More...
enum	ParentInPlaceMode {   PARENT_IN_PLACE_PREFERENCE,   PARENT_IN_PLACE_FORCED_ON,   PARENT_IN_PLACE_FORCED_OFF }
	The ParentInPlaceMode enum.
typedef unsigned long long	Flags

Public Member Functions
void	register_component_implementation ()
bool	is_translatable () const
	return true if the item can be translated
bool	is_rotatable () const
	return true if the item can be rotated
bool	is_scalable () const
	return true if the item can be scaled
bool	is_pivot_translatable () const
	return true if the pivot of the item can be translated
bool	is_pivot_rotatable () const
	return true if the pivot of the item can be rotated
bool	is_pivot_scalable () const
	return true if the pivot of the item can be scaled
ModuleSceneItem *	get_parent () const
	Returns the apparent scene item kinematic parent object if any, with respect to attr muted value or parent disabled state.
void	set_parent (ModuleSceneItem *item, const ParentInPlaceMode &mode=PARENT_IN_PLACE_FORCED_OFF)
	Set the kinematic parent for this item.
ModuleSceneItem *	get_serialized_parent () const
	Returns the actual scene item kinematic parent object if any, without considering attr muted value or parent disabled state.
void	set_rotation_order (const GMathRotationOrder &order)
void	set_rotation_offset_order (const GMathRotationOrder &order)
GMathRotationOrder	get_rotation_order () const
GMathRotationOrder	get_rotation_offset_order () const
void	set_transform (const GMathTransform &xform)
void	set_translation (const GMathVec3d &t, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the item translation in the given space.
void	set_rotation (const GMathVec3d &r, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the item rotation in the given space.
void	set_scaling (const GMathVec3d &s, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the item scaling in the given space.
void	set_shearing (const GMathVec3d &sh, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the item scaling in the given space.
void	change_translation (const GMathVec3d &t, const Space &space=SPACE_LOCAL, void *requester=0)
void	change_rotation (const GMathVec3d &r, const Space &space=SPACE_LOCAL, void *requester=0)
void	change_scaling (const GMathVec3d &s, const Space &space=SPACE_LOCAL, void *requester=0)
void	change_shearing (const GMathVec3d &sh, const Space &space=SPACE_LOCAL, void *requester=0)
void	set_translation_offset (const GMathVec3d &t, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the item translation offset in the given space.
void	set_rotation_offset (const GMathVec3d &r, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the item rotation offset in the given space.
void	set_scaling_offset (const GMathVec3d &s, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the item scaling offset in the given space.
void	change_translation_offset (const GMathVec3d &t, const Space &space=SPACE_LOCAL, void *requester=0)
void	change_rotation_offset (const GMathVec3d &r, const Space &space=SPACE_LOCAL, void *requester=0)
void	change_scaling_offset (const GMathVec3d &s, const Space &space=SPACE_LOCAL, void *requester=0)
void	set_rotation_pivot (const GMathVec3d &r, const Space &space=SPACE_LOCAL)
	Set the position of the rotation pivot in the given space.
void	set_scaling_pivot (const GMathVec3d &s, const Space &space=SPACE_LOCAL)
	Set the position of the scaling pivot in the given space.
void	change_rotation_pivot (const GMathVec3d &r, const Space &space=SPACE_LOCAL)
void	change_scaling_pivot (const GMathVec3d &s, const Space &space=SPACE_LOCAL)
void	reset_rotation_pivot ()
	Reset the rotation pivot to its initial position.
void	reset_scaling_pivot ()
	Reset the scaling pivot to its initial position.
void	inplace_set_translation (const GMathVec3d &t, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the kinematic translation without moving the object (offset the translation)
void	inplace_set_rotation (const GMathVec3d &r, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the kinematic rotation without moving the object (offset the rotatation)
void	inplace_set_scaling (const GMathVec3d &s, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the kinematic scaling without moving the object (offset the scale)
void	inplace_change_translation (const GMathVec3d &t, const Space &space=SPACE_LOCAL, void *requester=0)
void	inplace_change_rotation (const GMathVec3d &r, const Space &space=SPACE_LOCAL, void *requester=0)
void	inplace_change_scaling (const GMathVec3d &s, const Space &space=SPACE_LOCAL, void *requester=0)
void	inplace_set_translation_offset (const GMathVec3d &t, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the translation offset without moving the object.
void	inplace_set_rotation_offset (const GMathVec3d &r, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the rotation offset without moving the object.
void	inplace_set_scaling_offset (const GMathVec3d &s, const Space &space=SPACE_LOCAL, void *requester=0)
	Set the scaling offset without moving the object.
void	inplace_change_translation_offset (const GMathVec3d &t, const Space &space=SPACE_LOCAL, void *requester=0)
void	inplace_change_rotation_offset (const GMathVec3d &r, const Space &space=SPACE_LOCAL, void *requester=0)
void	inplace_change_scaling_offset (const GMathVec3d &s, const Space &space=SPACE_LOCAL, void *requester=0)
void	set_matrix (const GMathMatrix4x4d &matrix, const Space &space)
	Extract translation, rotation, scale and shear values from the given matrix.
GMathTransform	get_transform (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
GMathTransform	get_transform_at (const double &time) const
GMathTransform	compute_transform_at (const double &time) const
void	get_translation (GMathVec3d &t, const Space &space=SPACE_LOCAL, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the item translation in the given space.
void	get_rotation (GMathVec3d &r, const Space &space=SPACE_LOCAL, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the item rotation in the given space.
void	get_scaling (GMathVec3d &s, const Space &space=SPACE_LOCAL, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the item scale in the given space.
void	get_shearing (GMathVec3d &sh, const Space &space=SPACE_LOCAL, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the item shear in the given space.
void	get_translation_offset (GMathVec3d &t, const Space &space=SPACE_LOCAL, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the item translation in the given space.
void	get_rotation_offset (GMathVec3d &r, const Space &space=SPACE_LOCAL, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the item rotation in the given space.
void	get_scaling_offset (GMathVec3d &s, const Space &space=SPACE_LOCAL, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the item scaling in the given space.
void	get_rotation_pivot (GMathVec3d &r, const Space &space=SPACE_LOCAL, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the position of the rotation pivot in the given space.
void	get_scaling_pivot (GMathVec3d &s, const Space &space=SPACE_LOCAL, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the position of the scaling pivot in the given space.
void	get_rotation_pivot_matrix (GMathMatrix4x4d &r, const Space &space, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the item rotation pivot matrix in the given space.
void	get_scaling_pivot_matrix (GMathMatrix4x4d &r, const Space &space, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
	Returns the item scaling pivot matrix in the given space.
const GMathMatrix4x4d &	get_kinematic_matrix (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
const GMathMatrix4x4d &	get_object_matrix (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
const GMathMatrix4x4d &	get_global_matrix (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
const GMathMatrix4x4d &	get_inv_global_matrix (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
const GMathMatrix4x4d	get_reference_global_matrix () const
void	get_global_position (GMathVec3d &position, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
void	get_global_orientation (GMathMatrix4x4d &orientation, const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_CURRENT) const
void	get_translation_at (GMathVec3d &t, const double &time, const Space &space=SPACE_LOCAL) const
	Returns the item translation at the given time in the given space.
void	get_rotation_at (GMathVec3d &r, const double &time, const Space &space=SPACE_LOCAL) const
	Returns the item rotation at the given time in the given space.
void	get_scaling_at (GMathVec3d &s, const double &time, const Space &space=SPACE_LOCAL) const
	Returns the item scale at the given time in the given space.
void	get_shearing_at (GMathVec3d &sh, const double &time, const Space &space=SPACE_LOCAL) const
	Returns the item shear at the given time in the given space.
void	get_translation_offset_at (GMathVec3d &t, const double &time, const Space &space=SPACE_LOCAL) const
	Returns the item translation in the given space.
void	get_rotation_offset_at (GMathVec3d &r, const double &time, const Space &space=SPACE_LOCAL) const
	Returns the item rotation in the given space.
void	get_scaling_offset_at (GMathVec3d &s, const double &time, const Space &space=SPACE_LOCAL) const
	Returns the item scaling in the given space.
void	get_model_matrix_at (GMathMatrix4x4d &matrix, const double &time) const
GMathMatrix4x4d	get_kinematic_matrix_at (const double &time) const
	Returns the item kinematic matrix at the given time.
GMathMatrix4x4d	get_object_matrix_at (const double &time) const
	Returns the item object matrix at the given time.
GMathMatrix4x4d	get_global_matrix_at (const double &time) const
	Returns the item global matrix at the given time.
CoreBasicArray< GMathMatrix4x4d >	get_global_matrix_motion_blur_samples (const CtxEval &eval_ctx) const
	Return samples of the global matrix used for the motion blur.
GMathMatrix4x4d	get_global_matrix_motion_blur_at (const CtxEval &eval_ctx, const double &delta_time) const
	Returns the global matrix for the motion blur at the given time.
GMathMatrix4x4d	get_global_matrix_motion_blur (const CtxEval &eval_ctx, const GeometryMotionBlurSample &ms) const
	Returns the global matrix for the motion blur at the given motion blur sample.
void	get_global_position_at (GMathVec3d &position, const double &time) const
void	get_global_orientation (GMathMatrix4x4d &orientation, const double &time) const
const GMathVec3d &	get_display_color () const
bool	is_display_visible () const
bool	is_display_pickable () const
bool	is_display_motion_trail (bool selected) const
bool	is_constrained () const
short	get_xform_constraint_modifier () const
bool	is_animated () const
bool	is_motion_blur_enabled () const
bool	is_motion_blur_required () const
bool	is_motion_blurred () const
bool	is_locally_motion_blurred () const
bool	is_animation_motion_blurred () const
bool	has_kinematic_expression () const
bool	has_local_animation () const
void	enable_motion_blur (const bool &flag)
void	require_motion_blur (const int &increment)
void	require_motion_blur (const bool &flag)
void	set_matrices_as_dirty (const OfAttr::ValuePage &page=OfAttr::VALUE_PAGE_PREVIOUS)
size_t	get_memory_size () const override
const unsigned int &	get_object_count () const
const unsigned int &	get_object_id () const
bool	is_visibility_driven () const
CoreString	get_kinematic_full_name () const
	return the fullname of the item in the transformation hierarchy (world://item)
void	set_kinematic_full_name_dirty ()
bool	is_kinematic_full_name_dirty () const
bool	is_inherit_transform () const
unsigned int	get_reference_frame () const
double	get_reference_time () const
void	update_animation_motion_blur (const bool has_animation_motion_blur)
	update_animation_motion_blur Set the flag ANIMATED_MODEL_MATRIX according to has_animation_motion_blur. If the item has change is animation state then it will propagate motion blur dirtiness
const Flags &	get_flags () const
	Get flags that are enabled on the current scene item.
void	enable_flags (const Flags &flags)
	Enable flags on the current scene item.
void	disable_flags (const Flags &flags)
	Disable flags on the current scene item.
Public Member Functions inherited from ModuleGlObject
virtual bool	pre_paint_gl (GlUtilsCtx &ctx) const
virtual bool	paint_gl (GlUtilsCtx &ctx) const
virtual bool	destroy_gl_data (GlUtilsGlCtx &gl_ctx) const
virtual GMathBbox3d	get_gl_bbox (GlUtilsCtx &ctx) const

Static Public Member Functions
static const unsigned int &	get_object_count (OfApp &application)
static ModuleSceneItem *	get_scene_item (OfApp &application, const unsigned int &id)
	return the scene item from the specified id
static void	get_all_scene_items (OfApp &application, CoreVector< ModuleSceneItem * > &items)
	return the most up-to-date array of scene items
static VisibilityMode	get_visibility_mode (const OfObject &object)
static Flags	reserve_flag ()
	Get a flag that is not used yet and reserve it.

Protected Member Functions
void	on_attribute_change (const OfAttr &attr, int &dirtiness, const int &dirtiness_flags) override
void	module_constructor (OfObject &object) override
void	in_place_set_parent (const ModuleSceneItem *new_parent_module, const bool &in_place)

Static Protected Member Functions
static bool	is_in_place_parenting (OfApp &app, const ModuleSceneItem::ParentInPlaceMode &parent_in_place_mode)
	Compensate the transform of the parent to make sure the object doesn't move in the world.

Friends
class	SetParentCmd
struct	ModuleSceneItemHierarchyInfo

Additional Inherited Members
Static Public Attributes inherited from ModuleObject
static constexpr unsigned int	null_variation = 0
	Key of the null resource variation.

Member Enumeration Documentation

enum ModuleSceneItem::VisibilityMode

VisibilityMode describes how driven visibility attributes are set.

When using VISIBILITY_MODE_USE_PROPERTY, driven attributes are read only because their value is driven by another property.

Enumerator:

VISIBILITY_MODE_OVERRIDE	Visibility attributes are manually set by the user. It's the default mode.
VISIBILITY_MODE_USE_PROPERTY	Visibility attributes are driven by an external property (e.g. Alembic visibility properties).
VISIBILITY_MODE_USE_PREFERENCES	Visibility attributes are driven by the preferences.

Member Function Documentation

void ModuleSceneItem::get_all_scene_items ( OfApp &  application, CoreVector< ModuleSceneItem * > &  items  )

static

return the most up-to-date array of scene items

Parameters

items

all the scene items that are in the project

Note

Main thread gets always the most up-to-date array. If there is a running evaluation, the array returned to running threads is the one that was set before evaluation started. In other words, it may be incomplete.

GMathMatrix4x4d ModuleSceneItem::get_global_matrix_at

(

const double &

time

)

const

Returns the item global matrix at the given time.

Parameters

time	at which the transformation is computed

GMathMatrix4x4d ModuleSceneItem::get_global_matrix_motion_blur	(	const CtxEval &	eval_ctx,
		const GeometryMotionBlurSample &	ms
	)		const

Returns the global matrix for the motion blur at the given motion blur sample.

Note

This function returns matrices that are valid only for the current frame.

Parameters

eval_ctx	a valid evaluation context
ms	the motion blur sample

GMathMatrix4x4d ModuleSceneItem::get_global_matrix_motion_blur_at	(	const CtxEval &	eval_ctx,
		const double &	delta_time
	)		const

Returns the global matrix for the motion blur at the given time.

Note

This function returns matrices that are valid only for the current frame.

Parameters

eval_ctx	a valid evaluation context
delta_time	time relative to the current frame time

CoreBasicArray< GMathMatrix4x4d > ModuleSceneItem::get_global_matrix_motion_blur_samples

(

const CtxEval &

eval_ctx

)

const

Return samples of the global matrix used for the motion blur.

Note

This function returns matrices that are valid only for the current frame.

Parameters

eval_ctx

a valid evaluation context

GMathMatrix4x4d ModuleSceneItem::get_kinematic_matrix_at

(

const double &

time

)

const

Returns the item kinematic matrix at the given time.

Parameters

time	at which the transformation is computed

GMathMatrix4x4d ModuleSceneItem::get_object_matrix_at

(

const double &

time

)

const

Returns the item object matrix at the given time.

Parameters

time	at which the transformation is computed

ModuleSceneItem * ModuleSceneItem::get_parent

(

)

const

Returns the apparent scene item kinematic parent object if any, with respect to attr muted value or parent disabled state.

Returns

0 if the item has no parent

void ModuleSceneItem::get_rotation	(	GMathVec3d &	r,
		const Space &	space = SPACE_LOCAL,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the item rotation in the given space.

Parameters

space

in which the rotation is expressed

void ModuleSceneItem::get_rotation_at	(	GMathVec3d &	r,
		const double &	time,
		const Space &	space = SPACE_LOCAL
	)		const

Returns the item rotation at the given time in the given space.

Parameters

time	at which the rotation is computed
space	in which the rotation is expressed

void ModuleSceneItem::get_rotation_offset	(	GMathVec3d &	r,
		const Space &	space = SPACE_LOCAL,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the item rotation in the given space.

Parameters

space

in which the rotation is expressed

void ModuleSceneItem::get_rotation_offset_at	(	GMathVec3d &	r,
		const double &	time,
		const Space &	space = SPACE_LOCAL
	)		const

Returns the item rotation in the given space.

Parameters

space

in which the rotation is expressed

void ModuleSceneItem::get_rotation_pivot	(	GMathVec3d &	p,
		const Space &	space = SPACE_LOCAL,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the position of the rotation pivot in the given space.

Parameters

space

in which the position is expressed

void ModuleSceneItem::get_rotation_pivot_matrix	(	GMathMatrix4x4d &	m,
		const Space &	space,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the item rotation pivot matrix in the given space.

Parameters

space

in which the matrix is computed

void ModuleSceneItem::get_scaling	(	GMathVec3d &	s,
		const Space &	space = SPACE_LOCAL,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the item scale in the given space.

Parameters

space

in which the scale is expressed

void ModuleSceneItem::get_scaling_at	(	GMathVec3d &	s,
		const double &	time,
		const Space &	space = SPACE_LOCAL
	)		const

Returns the item scale at the given time in the given space.

Parameters

time	at which the scale is computed
space	in which the scale is expressed

void ModuleSceneItem::get_scaling_offset	(	GMathVec3d &	s,
		const Space &	space = SPACE_LOCAL,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the item scaling in the given space.

Parameters

space

in which the scaling is expressed

void ModuleSceneItem::get_scaling_offset_at	(	GMathVec3d &	s,
		const double &	time,
		const Space &	space = SPACE_LOCAL
	)		const

Returns the item scaling in the given space.

Parameters

space

in which the scaling is expressed

void ModuleSceneItem::get_scaling_pivot	(	GMathVec3d &	p,
		const Space &	space = SPACE_LOCAL,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the position of the scaling pivot in the given space.

Parameters

space

in which the position is expressed

void ModuleSceneItem::get_scaling_pivot_matrix	(	GMathMatrix4x4d &	m,
		const Space &	space,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the item scaling pivot matrix in the given space.

Parameters

space

in which the matrix is computed

ModuleSceneItem * ModuleSceneItem::get_scene_item ( OfApp &  application, const unsigned int &  id  )

static

return the scene item from the specified id

Parameters

id	id of the scene item

ModuleSceneItem * ModuleSceneItem::get_serialized_parent

(

)

const

Returns the actual scene item kinematic parent object if any, without considering attr muted value or parent disabled state.

Returns

0 if the item has no parent

void ModuleSceneItem::get_shearing	(	GMathVec3d &	sh,
		const Space &	space = SPACE_LOCAL,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the item shear in the given space.

Parameters

space

in which the shear is expressed

void ModuleSceneItem::get_shearing_at	(	GMathVec3d &	sh,
		const double &	time,
		const Space &	space = SPACE_LOCAL
	)		const

Returns the item shear at the given time in the given space.

Parameters

time	at which the shear is computed
space	in which the shear is expressed

void ModuleSceneItem::get_translation	(	GMathVec3d &	t,
		const Space &	space = SPACE_LOCAL,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the item translation in the given space.

Parameters

space

in which the translation is expressed

void ModuleSceneItem::get_translation_at	(	GMathVec3d &	t,
		const double &	time,
		const Space &	space = SPACE_LOCAL
	)		const

Returns the item translation at the given time in the given space.

Parameters

time	at which the translation is computed
space	in which the translation is expressed

void ModuleSceneItem::get_translation_offset	(	GMathVec3d &	t,
		const Space &	space = SPACE_LOCAL,
		const OfAttr::ValuePage &	page = OfAttr::VALUE_PAGE_CURRENT
	)		const

Returns the item translation in the given space.

Parameters

space

in which the translation is expressed

void ModuleSceneItem::get_translation_offset_at	(	GMathVec3d &	t,
		const double &	time,
		const Space &	space = SPACE_LOCAL
	)		const

Returns the item translation in the given space.

Parameters

space

in which the translation is expressed

ModuleSceneItem::VisibilityMode ModuleSceneItem::get_visibility_mode ( const OfObject &  object )

static

Get the current visibility mode of this SceneItem.

void ModuleSceneItem::inplace_set_rotation	(	const GMathVec3d &	r,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the kinematic rotation without moving the object (offset the rotatation)

Parameters

r	the rotation vector
space	in which the rotation occurs
requester	pointer to the requester

void ModuleSceneItem::inplace_set_rotation_offset	(	const GMathVec3d &	r,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the rotation offset without moving the object.

Parameters

r	the rotation vector
space	in which the rotation occurs
requester	pointer to the requester

void ModuleSceneItem::inplace_set_scaling	(	const GMathVec3d &	s,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the kinematic scaling without moving the object (offset the scale)

Parameters

s	the scaling vector
space	in which the scaling occurs
requester	pointer to the requester

void ModuleSceneItem::inplace_set_scaling_offset	(	const GMathVec3d &	s,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the scaling offset without moving the object.

Parameters

s	the scaling vector
space	in which the scaling occurs
requester	pointer to the requester

void ModuleSceneItem::inplace_set_translation	(	const GMathVec3d &	t,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the kinematic translation without moving the object (offset the translation)

Parameters

t	the translation vector
space	in which the translation occurs
requester	pointer to the requester

void ModuleSceneItem::inplace_set_translation_offset	(	const GMathVec3d &	t,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the translation offset without moving the object.

Parameters

t	the translation vector
space	in which the translation occurs
requester	pointer to the requester

bool ModuleSceneItem::is_display_motion_trail

(

bool

selected

)

const

depending on animation state, motion trail display property, and the current selected state given as argument, returns whether the motion trail should be displayed

bool ModuleSceneItem::is_rotatable

(

)

const

return true if the item can be rotated

Note

if any value of the attribute is locked, the item is considered as not editable

bool ModuleSceneItem::is_scalable

(

)

const

return true if the item can be scaled

Note

if any value of the attribute is locked, the item is considered as not editable

bool ModuleSceneItem::is_translatable

(

)

const

return true if the item can be translated

Note

if any value of the attribute is locked, the item is considered as not editable

bool ModuleSceneItem::is_visibility_driven

(

)

const

Returns true if the SceneItem supports visibility driven by a property.

For example Alembic and USD objects have a visibility property that can be read to drive the visibility in Clarisse

Returns

true if supports driven visibility, false otherwise

void ModuleSceneItem::set_matrix	(	const GMathMatrix4x4d &	matrix,
		const Space &	space
	)

Extract translation, rotation, scale and shear values from the given matrix.

Parameters

matrix	matrix from which to extract values
space	the space in which is expressed the matrix

void ModuleSceneItem::set_parent	(	ModuleSceneItem *	item,
		const ParentInPlaceMode &	mode = PARENT_IN_PLACE_FORCED_OFF
	)

Set the kinematic parent for this item.

Parameters

item	the kinematic parent

Note

setting a null kinematic parent will unparent this item

void ModuleSceneItem::set_rotation	(	const GMathVec3d &	r,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the item rotation in the given space.

Parameters

t	the rotation vector
space	in which the rotation occurs
requester	pointer to the requester

void ModuleSceneItem::set_rotation_offset	(	const GMathVec3d &	r,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the item rotation offset in the given space.

Parameters

t	the rotation vector
space	in which the rotation occurs
requester	pointer to the requester

void ModuleSceneItem::set_rotation_pivot	(	const GMathVec3d &	p,
		const Space &	space = SPACE_LOCAL
	)

Set the position of the rotation pivot in the given space.

Parameters

t	the position of the pivot
space	in which the position is expressed

void ModuleSceneItem::set_scaling	(	const GMathVec3d &	s,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the item scaling in the given space.

Parameters

s	the scaling vector
space	in which the scaling occurs
requester	pointer to the requester

void ModuleSceneItem::set_scaling_offset	(	const GMathVec3d &	s,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the item scaling offset in the given space.

Parameters

s	the scaling vector
space	in which the scaling occurs
requester	pointer to the requester

void ModuleSceneItem::set_scaling_pivot	(	const GMathVec3d &	p,
		const Space &	space = SPACE_LOCAL
	)

Set the position of the scaling pivot in the given space.

Parameters

t	the position of the pivot
space	in which the position is expressed

void ModuleSceneItem::set_shearing	(	const GMathVec3d &	sh,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the item scaling in the given space.

Parameters

s	the scaling vector
space	in which the scaling occurs
requester	pointer to the requester

void ModuleSceneItem::set_translation	(	const GMathVec3d &	t,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the item translation in the given space.

Parameters

t	the translation vector
space	in which the translation occurs
requester	pointer to the requester

void ModuleSceneItem::set_translation_offset	(	const GMathVec3d &	t,
		const Space &	space = SPACE_LOCAL,
		void *	requester = 0
	)

Set the item translation offset in the given space.

Parameters

t	the translation vector
space	in which the translation occurs
requester	pointer to the requester